Load Data To Preview (Data Management)

Summary

Uses a Data Loading Workspace to load data from a source to a preview geodatabase. Use this tool to preview the results before loading data to the target schema.

Usage

  • A copy of the target schema is created and the data is loaded to that copy.

Parameters

LabelExplanationData Type
Data Reference Workbook

The path to the Data Reference Workbook defining the data source, target, and mapping workbook paths.

File
Preview Output Folder

The output folder where the preview geodatabase will be created.

Folder

Derived Output

LabelExplanationData Type
Output Datasets

A list of target dataset paths listing where data was loaded.

Table View

arcpy.management.LoadDataToPreview(in_workbook, out_folder)
NameExplanationData Type
in_workbook

The path to the Data Reference Workbook defining the data source, target, and mapping workbook paths.

File
out_folder

The output folder where the preview geodatabase will be created.

Folder

Derived Output

NameExplanationData Type
out_datasets

A list of target dataset paths listing where data was loaded.

Table View

Code sample

LoadDataToPreview example (Python window)

The following Python window script demonstrates how to use the LoadDataToPreview function in immediate mode.

import arcpy

arcpy.management.LoadDataToPreview("C:/data/DataLoadingWorkspace/DataReference.xlsx", "C:/temp")
LoadDataToPreview example (stand-alone script)

The following script demonstrates how to use the LoadDataToPreview function in a stand-alone script.

# Name: LoadDataToPreview.py
# Description: Load the source-target mapping defined in DataReference.xlsx to a preview geodatabase

# Import system modules
import arcpy

# Set local variables
workbook = "C:/data/DataLoadingWorkspace/DataReference.xlsx"
folder = "C:/temp"

arcpy.management.LoadDataToPreview(in_workbook=workbook, out_folder=folder)

Environments

This tool does not use any geoprocessing environments.

Related topics