Manage Analytics dataflows and dataflow jobs.
analytics:dataflow:history:list (Deprecated)
Lists history records for Analytics dataflows in the specified target org.
analytics:dataflow:history:revert (Deprecated)
Revert to a specified history record.
analytics:dataflow:job:display (Deprecated)
Display the status of an Analytics dataflow job.
analytics:dataflow:job:list (Deprecated)
Lists jobs for an Analytics dataflow.
analytics:dataflow:job:stop (Deprecated)
Stops an Analytics dataflow job.
analytics:dataflow:list (Deprecated)
Lists Analytics dataflows in the specified target org.
analytics:dataflow:start (Deprecated)
Starts an Analytics dataflow.
analytics:dataflow:update (Deprecated)
Update an Analytics dataflow.
Lists history records for Analytics dataflows in the specified target org.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:history:list --dataflowid <dataflowid>sfdx analytics:dataflow:history:list[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i DATAFLOWID
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowid DATAFLOWIDRequired
The ID of the dataflow to show history records.
Type: id
Revert to a specified history record.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:history:revert -i <dataflowid> -y <historyid> -l <historyLabel>sfdx analytics:dataflow:history:revert[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i DATAFLOWID
-y HISTORYID
[-l LABEL]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowid DATAFLOWIDRequired
The ID of the dataflow to show history records.
Type: id
-y | --historyid HISTORYIDRequired
The ID of the dataflow history record.
Type: id
-l | --label LABELOptional
Label for new reverted history record.
Type: string
Display the status of an Analytics dataflow job.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:job:display --dataflowjobid dataflowJobIdsfdx analytics:dataflow:job:display[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i DATAFFLOWJOBID]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowjobid DATAFLOWJOBIDRequired
ID of the dataflow job to display.
Type: id
Lists jobs for an Analytics dataflow.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:job:list --dataflowid dataflowIdsfdx analytics:dataflow:job:list[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i DATAFFLOWID]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowid DATAFLOWIDRequired
ID of the dataflow to list the jobs for.
Type: id
Stops an Analytics dataflow job.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:job:stop --dataflowjobid dataflowJobIdsfdx analytics:dataflow:job:stop[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i DATAFFLOWJOBID]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowjobid DATAFLOWJOBIDRequired
ID of the dataflow job to stop.
Type: id
Lists Analytics dataflows in the specified target org.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:listsfdx analytics:dataflow:list[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
Starts an Analytics dataflow.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:start --dataflowid dataflowIdsfdx analytics:dataflow:start[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i DATAFFLOWID]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowid DATAFLOWIDRequired
ID of the dataflow to start.
Type: id
Update an Analytics dataflow.
As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.
The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.
The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.
For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.
Warning
1sfdx analytics:dataflow:update --dataflowid dataflowId --dataflowfile dataflow-file.jsonsfdx analytics:dataflow:update[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i DATAFFLOWID]
[-f DATAFFLOWFILE]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-u | --targetusername TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --dataflowid DATAFLOWIDRequired
ID of the dataflow to start.
Type: id
-f | --dataflowfile DATAFLOWFILEOptional
The dataflow JSON file to update the dataflow with.
Type: filepath
j