Remove Dataset From Big Data Connection (GeoAnalytics Desktop)

Summary

Removes one or more datasets from an existing big data connection (BDC). This tool only removes the dataset from the BDC file, the source data is not modified.

Usage

  • This tool requires a BDC. To create a BDC, use the New Big Data Connection dialog or Create Big Data Connection tool.

  • Use this tool to remove a dataset from a BDC to limit the datasets available for analysis. The following are examples:

    • The source location you connected to contains datasets for three locations of interest, but you are tasked with analyzing only one of them. Remove the unused datasets so you only see the desired datasets in the BDC.
    • Datasets have been deleted from the source location and you want to remove them from your BDC.
    • You want to share specific datasets with a colleague, so you create a BDC for them and keep only the datasets you want to share.

    A removed dataset will no longer be listed in the BDC.

  • The source data will not be deleted for the removed datasets. Datasets will only be removed from the BDC.

  • To add a dataset back to a BDC, use the Refresh Big Data Connection tool.

  • To delete a BDC permanently, delete the .bdc file.

  • The Remove Dataset From Big Data Connection tool removes an existing dataset from BDC. Additional tools can be used to modify a BDC:

  • This geoprocessing tool is powered by Spark. See Big data connections to learn more about big data connections and how to use them.

Parameters

LabelExplanationData Type
Big Data Connection Datasets

The datasets to remove from the .bdc file.

Table View

Derived Output

LabelExplanationData Type
Updated BDC

The input .bdc file with updated datasets.

File

arcpy.gapro.RemoveDatasetFromBDC(bdc_datasets)
NameExplanationData Type
bdc_datasets
[bdc_datasets,...]

The datasets to remove from the .bdc file.

Table View

Derived Output

NameExplanationData Type
updated_bdc

The input .bdc file with updated datasets.

File

Code sample

RemoveDatasetFromBDC (stand-alone script)

The following Python script demonstrates how to use the RemoveDatasetFromBDC tool.

# Name: RemoveDatasetFromBDC.py
# Description: Remove specified datasets from one or more big data connection files.

# Requirements: ArcGIS Pro Advanced License

# Import system modules
import arcpy

# Set local variables
datasets = [r"c:\Projects\MyProjectFolder\my_BigDataConnection.bdc\Dataset1", 
            r"c:\Projects\MyProjectFolder\my_BigDataConnection.bdc\Dataset2"]

# Execute Remove Dataset From Big Data Connection
arcpy.gapro.RemoveDatasetFromBDC(datasets)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics