Create Multifile Feature Connection (GeoAnalytics Desktop)

Summary

Creates a multifile feature connection file (.mfc) and item. Datasets registered in a multifile feature connection (MFC) can be used as input to GeoAnalytics Desktop tools and other geoprocessing tools.

Usage

• Use this tool to establish a connection to one or more datasets that you can use as input to geoprocessing tools.

  Note:

  You can optionally create a multifile feature connection using the New Multifile Feature Connection dialog.

• Multifile feature connections support the following datasets:

  • Delimited files (such as .csv, .tsv, and .txt)
  • Shapefiles (.shp)
  • Parquet files (.parquet)

    Note:

    Only unencrypted parquet files are supported.

  • ORC files (.orc)

  To learn more about supported file types, see Multifile feature connections.

• To use your datasets as inputs in a MFC, the data must be correctly structured. To prepare your data for a MFC, format your datasets as subfolders under a single source folder that you register. In this source folder, the names of the subfolders represent the dataset names.

  

  A source folder that contains three subfolders, each representing a dataset, is shown.

  The image above represents the correct structure of a MFC. The source folder is registered, and each subfolder in the source folder represents a dataset. In this example, you would register the source folder, and three datasets would be included in the MFC: Dataset-1, Dataset-2, and Dataset-3.

  Learn more about structuring a multifile feature connection

• Specify the source location from which you want to create a MFC using the Data Source Folder parameter.

• A MFC can be stored locally on your machine or on a network drive. If you are sharing a MFC, ensure that you use a source location that all users can access. It is recommended that you not store a MFC in the source folder.

• To access a MFC in a project, add the location of the stored MFC as a folder connection.

• Setting the geometry or time visibility does not remove geometry or time from the datasets. The time and geometry settings will always apply. For example, if you have a point dataset with geometry represented by two fields, latitude and longitude, the following outlines how the visibility setting will work with your dataset:

  • Visible—the latitude and longitude fields will be available in geoprocessing tool parameters and results.
  • Not Visible—The latitude and longitude fields will not be available in geoprocessing tool parameters or in the output results.

  In both cases, the dataset will have geometry defined by the latitude and longitude fields.

• It is recommended that you set geometry fields to Not Visible when you are using long string values such as WKT to represent geometry.

• Manually modifying a .mfc file is not recommended. A .mfc file contains the following properties:

  • Connection information—The source path
  • Dataset information—The dataset names and types, fields, geometry, and time

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

  • 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 your 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 have created a MFC, you can modify the connection information and datasets using the following tools:

  • 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.
  • Refresh Multifile Feature Connection—Checks for any new datasets and add them to the MFC.
  • 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 Output Location (Optional)	The folder where the .mfc file will be created.	Folder
Output Multifile Feature Connection Name	The name of the .mfc file to be created.	String
Connection Type	Specifies the type of connection to be created. Folder—Connect to a file system location. This is the default.	String
Data Source Folder (Optional)	The folder containing the datasets to be registered with the MFC.	Folder
Visible Geometry Fields (Optional)	Specifies whether the fields used to specify the geometry will be visible as fields when the MFC file is used as input to other geoprocessing tools. When the 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 specify the time will be visible as fields when the MFC file is used as input to other geoprocessing tools. When the 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
Output MFC	The .mfc file that is created.	File

Python

arcpy.gapro.CreateBDC({bdc_location}, bdc_name, connection_type, {data_source_folder}, {visible_geometry}, {visible_time})

Name	Explanation	Data Type
bdc_location (Optional)	The folder where the .mfc file will be created.	Folder
bdc_name	The name of the .mfc file to be created.	String
connection_type	Specifies the type of connection to be created. FOLDER—Connect to a file system location. This is the default.	String
data_source_folder (Optional)	The folder containing the datasets to be registered with the MFC.	Folder
visible_geometry (Optional)	Specifies whether the fields used to specify the geometry will be visible as fields when the MFC file is used as input to other geoprocessing tools. When the 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 specify the time will be visible as fields when the MFC file is used as input to other geoprocessing tools. When the 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
output_bdc	The .mfc file that is created.	File

Code sample

CreateBDC (stand-alone script)

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

# Name: CreateBigDataConnection.py
# Description: Establishes a connection to a folder location containing one or 
#              more datasets. Datasets will be used as input to GeoAnalytics 
#              Desktop Tools.
#
# Requirements: ArcGIS Pro Advanced License

# Import system modules
import arcpy

# Set local variables
sourceFolder = r"\\FileShare\MyLargeDatasets"
outName = "my_new_MultifileFeatureConnection"
outFolder = r"c:\Projects\MyProjectFolder"
time = "TIME_NOT_VISIBLE"
geometry = "GEOMETRY_VISIBLE"

# Run Create Multifile Feature Connection
arcpy.gapro.CreateBDC(outFolder, outName, "FOLDER", sourceFolder, geometry, time)

Environments

This tool does not use any geoprocessing environments.

Licensing information

• Basic: No
• Standard: No
• Advanced: Yes