Running a Refresh update

This topic describes how to run a Refresh update operation.

This procedure assumes that:
  • The data set has been created, either from Studio or with the DP CLI.
  • The data set has been added to a Studio project.

To run a Refresh update on a data set:

  1. Obtain the Data Set Logical Name of the data set you want to refresh:
    1. In Studio, go to Project Settings and then Data Set Manager.
    2. In the Data Set Manager, select the data set and expand the options next to its name.
    3. Get the value from the Data Set Logical Name field.
  2. From a Linux command prompt, change to the $BDD_HOME/dataprocessing/edp_cli directory.
  3. Run the DP CLI with the --refreshData flag and the Data Set Logical Name. For example: 
    ./data_processing_CLI --refreshData 10128:WarrantyClaims
If the workflow was successfully invoked, the DP CLI prints these messages at the end of the stdout output: 
...
Refreshing existing collection: MdexCollectionIdentifier{
   databaseName=edp_cli_edp_db627d25-fe2f-4117-a068-b742bb699650, 
   collectionName=edp_cli_edp_db627d25-fe2f-4117-a068-b742bb699650}
Collection key for new record:  MdexCollectionIdentifier{
   databaseName=refreshed_edp_9279101f-6c77-40f2-ab6d-5e4332a0be1c, 
   collectionName=refreshed_edp_9279101f-6c77-40f2-ab6d-5e4332a0be1c}
   jobId: 06ea3ebd-1b31-4a74-84d1-db2dfb6299cd
data_processing_CLI finished with state SUCCESS
If the Refresh update operation successfully finished, the YARN Application Overview page should have a State of "FINISHED" and a FinalStatus of "SUCCEEDED". The Name field will have an entry similar to this example: 
EDP: DatasetRefreshConfig{hiveDatabase=, hiveTable=, 
collectionToRefresh=MdexCollectionIdentifier{
    databaseName=edp_cli_edp_db627d25-fe2f-4117-a068-b742bb699650, 
    collectionName=edp_cli_edp_db627d25-fe2f-4117-a068-b742bb699650}, 
newCollectionId=MdexCollectionIdentifier{
   databaseName=refreshed_edp_9279101f-6c77-40f2-ab6d-5e4332a0be1c, 
   collectionName=refreshed_edp_9279101f-6c77-40f2-ab6d-5e4332a0be1c}, 
   op=REFRESH_DATASET, jobId=06ea3ebd-1b31-4a74-84d1-db2dfb6299cd}
Note the following about the Name information:
  • hiveDatabase and hiveTable are blank because the --database and --table flags were not used. In this case, the Refresh update operation uses the same Hive table and database that were used when the data set was first created.
  • collectionToRefresh is name of the data set that was refreshed. This name is the same as the Refreshing existing collection field in the stdout listed above.
  • newCollectionId is an internal name for the refreshed data set. This name will not appear in the Studio UI (the original Data Set Logical Name will continue to be used as it is a persistent name). This name is also the same as the Collection key for new record field in the stdout listed above.

You can also check the Dgraph HDFS Agent log for the status of the Dgraph ingest operation.

Note that future Refresh updates on this data set will continue to use the same Data Set Logical Name. You will also use this name if you set up a Refresh update cron job for this data set.