Refresh Multifile Feature Connection (GeoAnalytics Desktop)

Summary

Refreshes an existing multifile feature connection (MFC) and registers any new datasets that have been added to the source location.

Usage

• This tool requires a MFC. To create a MFC, use the Create Multifile Feature Connection tool.

• Use this tool to add one or more new datasets to an existing multifile feature connection. Additionally, the tool will reregister any datasets that have been removed using the Remove Dataset From Multifile Feature Connection tool. The following are examples of when to use this tool:

  • You copied a folder of data to your existing MFC source folder and want it represented as a dataset in your MFC.
  • You used the Remove Dataset From Multifile Feature Connection tool and you want to add the removed datasets back to the MFC.

• This tool does not refresh existing dataset properties that have been edited using the Update Multifile Feature Connection Dataset Properties tool. All modified properties will be maintained. The following scenarios include the recommended workflows:

  • You modified the schema of an existing source dataset—Use the Update Multifile Feature Connection Dataset Properties tool to modify the fields. You can also use the Remove Dataset From Multifile Feature Connection tool to remove the dataset and the Refresh Multifile Feature Connection tool if there are no existing modifications to the MFC dataset that you want to maintain.
  • You added new files to an existing dataset—No additional steps are required. When you run a geoprocessing tool to analyze your MFC data, all files in the MFC dataset will be included for analysis.
  • You deleted an existing dataset—Use the Remove Dataset From Multifile Feature Connection tool to remove the dataset from the MFC

• The tool messages will include the following information on the datasets discovered and their status:

  • Skipped—All existing datasets are skipped during refresh and remain as is.
  • Succeeded—New datasets that have been discovered and added to the MFC.
  • Failed—Datasets that were not successfully added to the MFC.

  You may run into one of two issues when discovering datasets in an MFC:

  • Datasets that you expected are missing. In this case, verify that the path you specified as a source folder that contains subfolders is correct and that it's a supported data type.
  • One or more datasets fail to register. If datasets fail to register, you may note some of the following:

    Issue	Solution	Example
    The dataset is not in the expected format.	Open the file to see if it looks as expected. If the data is structured incorrectly, update and try again.	A .csv file has a few lines and a summary of the data and then only empty lines.
    The schemas of datasets in a folder do not match.	All files in a dataset folder must have the same schema. Open the files to compare the schemas. Resolve any mismatched schemas and try to register the dataset again.	You have one .csv file with 10 fields and another with 8.
    The file types of a dataset in a folder do not match.	All files in a dataset folder must have the same extension (file type). Check the file types of the data source location and remove or relocate any misplaced files.	A shapefile dataset is in the same folder as a parquet file.
    You have an unrecognized field format.	This is unlikely but may occur if ORC and parquet use an unexpected format. Ensure that you use valid field formats.	You have a parquet file with an unknown field format.

  Learn more about why datasets fail to add to a MFC file

• Once you refresh a MFC, use the Describe Dataset tool to verify that the updated dataset looks as expected.

• The Refresh Multifile Feature Connection tools identifies new datasets. The following tools can also be used to modify a MFC:

  • Copy Dataset From Multifile Feature Connection—Copies a dataset from a MFC to a feature class.
  • Duplicate Dataset From Multifile Feature Connection—Creates a view of an existing MFC dataset.
  • Remove Dataset From Multifile Feature Connection—Removes a dataset from the MFC.
  • Update Multifile Feature Connection Dataset Properties—Modifies the properties of an individual MFC dataset.
  • Preview Dataset From Multifile Feature Connection—Previews the first ten features in your dataset to verify they are correctly registered.
  • Describe Dataset — To verify that the dataset looks as expected.

• This geoprocessing tool is powered by Spark. See Multifile feature connections to learn more about multifile feature connections and how to use them.

Parameters

Dialog

Label	Explanation	Data Type
Multifile Feature Connection File	The MFC file to refresh.	File
Visible Geometry Fields (Optional)	Specifies whether the fields used to identify the geometry will be included (visible) as fields for analysis when the MFC file is used in other geoprocessing tools. When geometry fields are not visible, geometry is still applied to the dataset. The geometry visibility setting can be modified in the MFC. Checked—Geometry fields will be included as fields for analysis. This is the default. Unchecked—Geometry fields will not be included as fields for analysis.	Boolean
Visible Time Fields (Optional)	Specifies whether the fields used to indicate the time will be included (visible) as fields for analysis when the MFC file is used in other geoprocessing tools. When time fields are not visible, time is still applied to the dataset. The time visibility setting can be modified in the MFC. Checked—Time fields will be included as fields for analysis. This is the default. Unchecked—Time fields will not be included as fields for analysis.	Boolean

Derived Output

Label	Explanation	Data Type
Updated MFC	The input .mfc file with updated datasets.	File

Python

arcpy.geoanalytics.RefreshBDC(bdc_file, {visible_geometry}, {visible_time})

Name	Explanation	Data Type
bdc_file	The MFC file to refresh.	File
visible_geometry (Optional)	Specifies whether the fields used to identify the geometry will be included (visible) as fields for analysis when the MFC file is used in other geoprocessing tools. When geometry fields are not visible, geometry is still applied to the dataset. The geometry visibility setting can be modified in the MFC. GEOMETRY_VISIBLE—Geometry fields will be included as fields for analysis. This is the default. GEOMETRY_NOT_VISIBLE—Geometry fields will not be included as fields for analysis.	Boolean
visible_time (Optional)	Specifies whether the fields used to indicate the time will be included (visible) as fields for analysis when the MFC file is used in other geoprocessing tools. When time fields are not visible, time is still applied to the dataset. The time visibility setting can be modified in the MFC. TIME_VISIBLE—Time fields will be included as fields for analysis. This is the default. TIME_NOT_VISIBLE—Time fields will not be included as fields for analysis.	Boolean

Derived Output

Name	Explanation	Data Type
updated_bdc	The input .mfc file with updated datasets.	File

Code sample

RefreshBDC (stand-alone script)

The following Python script demonstrates how to use the RefreshBDC function.

# Name: RefreshBDC.py
# Description: Refreshes a multifile feature connection to automatically discover datasets that 
#              have been added.
#
# Requirements: ArcGIS Pro Advanced License

# Import system modules
import arcpy

# Set local variables
mfcFile = r"c:\Projects\MyProjectFolder\my_BigDataConnection.mfc"

# Run Refresh Multifile Feature Connection
arcpy.gapro.RefreshBDC(mfcFile)

Environments

This tool does not use any geoprocessing environments.