Skip to main content

Create Replica (Data Management Tools)

Summary

Creates a replica in a geodatabase from a specified list of feature classes, layers, datasets, and tables in an enterprise geodatabase.

Usage

  • All datasets must be from the same source (parent) enterprise geodatabase.

  • Confirm that the field names in the source (parent) geodatabase do not exceed the maximum field name length supported in the database where the target (child) geodatabase is stored. If the target geodatabase cannot store all the characters, the field names will be truncated. This results in field names that do not match. Subsequent replica synchronizations will not transfer edits between those fields due to the mismatched field names.

  • The data that will be replicated must be registered as traditional versioned but not with the option to move edits to base.

  • The connected database user must also have write permissions to the data.

  • For two-way and both types of one-way replicas, all datasets must have a GlobalID column.

  • For check-out and one-way replicas, the child replica geodatabase can be an enterprise or file geodatabase.

  • For two-way and one-way child-to-parent replicas, the child geodatabase must be an enterprise geodatabase.

  • To use archiving for one-way replicas, the parent workspace must be connected to the default version. For one-way child-to-parent replicas, the child workspace must be connected to the default version.

  • You can replicate all of the data in the datasets or replicate subsets of the data. You can specify the subsets of data to be replicated in the following ways:

    • Use definition queries on the data.

    • Specify an extent using the geoprocessing Extent environment setting.

    • Use the Replica Geometry Features parameter in this tool.

  • For tables, the default filter is schema only; only the schema for the table will be replicated. To apply a filter to a table, first create a table view with the appropriate filters. Then use this result as input to this tool. See Make Table View for more information. For more information about filters and replication, see Prepare data for replication.

  • You can use the Replica Geometry Features parameter or the Extent environment setting to define the replica geometry.

    • If a value is provided for the Replica Geometry Features parameter, it will be used as the replica geometry.

    • If no value is provided for the Replica Geometry Features parameter, the Extent environment will be used as the replica geometry.

    • If neither the Replica Geometry Features parameter value nor the Extent environment is specified, the full extent of the data will be used.

  • The replica geometry features can be points, lines, or polygons.

  • A feature layer used for the replica geometry features can contain one or more features. If there is more than one, the geometries are merged, and only data that intersects the merged geometries will be replicated.

  • If filters (such as selection or definition query) have been defined on the replica geometry features, only features that satisfy these filters will be used to define the replica geometry. See Prepare data for replication for more information.

  • The Re-use Schema parameter options are only available for checkout replicas.

Parameters

Label Explanation Data type

Replica Datasets

The data that will be replicated. This list consists of layers and tables referencing versioned, editable data from an enterprise geodatabase.

Table View; Dataset

Replica Type

Specifies the type of replica that will be created.

  • Two way replica—Changes will be sent between child and parent replicas in both directions.

  • One way replica—Changes will be sent from the parent replica to the child replica only.

  • Check out replica—Data will be replicated, edited, and checked back in one time.

  • One way child to parent replica—Changes will be sent from the child replica to the parent replica only.

String

Geodatabase to replicate data to

(Optional)

The geodatabase that will host the child replica. Geodata services are used to represent remote geodatabases. The geodatabase can be an enterprise or file geodatabase. For two-way and one-way-child-to-parent replicas, the child geodatabase must be an enterprise geodatabase. For one-way and checkout replicas, the geodatabase can be a file or enterprise geodatabase.

This parameter is required if the Output Type parameter is set to Geodatabase.

Workspace; GeoDataServer

Replica Name

The name that identifies the replica.

String

Replica Access Type

(Optional)

Specifies the type of replica access.

  • Full—Complex types such as topologies, are supported and the data must be versioned. This is the default.

  • Simple—The data on the child is not versioned and must be simple. This allows the replica to be interoperable. Nonsimple features in the parent (for example, features in topologies) will be converted to simple features (for example, point, line, and polygon feature classes).

String

Initial Data Sender

(Optional)

Specifies which replica will send changes when in disconnected mode. If you are working in a connected mode, this parameter is inconsequential. This ensures that the relative replica will not send updates until the changes are first received from the initial data sender.

  • Child data sender—The child replica will be the initial data sender. This is the default.

  • Parent data sender—The parent replica will be the initial data sender.

String

Expand Feature Classes and Tables

(Optional)

Specifies whether expanded feature classes and tables—such as those in networks, topologies, or relationship classes—will be added.

  • Use defaults—The expanded feature classes and tables related to the feature classes and tables in the replica will be added. The default for feature classes is to replicate all features intersecting the spatial filter. If no spatial filter has been provided, all features will be included. The default for tables is to replicate the schema only. This is the default.

  • Add with schema only—Only the schema for the expanded feature classes and tables will be added.

  • All rows—All rows for expanded feature classes and tables will be added.

  • Do not add—No expanded feature classes or tables will be added.

String

Re-use Schema

(Optional)

Specifies whether a geodatabase that contains the schema of the data to be replicated will be reused. This reduces the amount of time required to replicate the data. This parameter is only available for checkout replicas.

  • Do not reuse—Schema will not be reused. This is the default.

  • Reuse—Schema will be used.

String

Replicate Related Data

(Optional)

Specifies whether rows related to rows existing in the replica will be replicated. For example, a feature (f1) is inside the replication filter and a related feature (f2) from another class is outside the filter. Feature f2 will be included in the replica if you choose to get related data.

  • Do not get related—Related data will not be replicated.

  • Get related—Related data will be replicated. This is the default.

String

Replica Geometry Features

(Optional)

The features that will be used to define the area to replicate.

Feature Layer

Use archiving to track changes for 1 way replication

(Optional)

Specifies whether the archive class will be used to track changes instead of the versioning delta tables. This is only available for one-way replicas.

  • Checked—Archiving will be used to track changes.

  • Unchecked—Archiving will not be used to track changes. This is the default.

Boolean

Register existing data only

(Optional)

Specifies whether existing data in the child geodatabase will be used to register the replica datasets. The datasets in the child geodatabase must have the same names as the datasets in the parent geodatabase.

  • Checked—Existing data in the child geodatabase will be used to register the replica.

  • Unchecked—Data in the parent geodatabase will be copied to the child geodatabase. This is the default.

Boolean

Output Type

(Optional)

Specifies the output type of the data that will be replicated.

  • Geodatabase—The data will be replicated to an existing geodatabase. This is the default.

  • Xml file—The data will be replicated to an XML workspace document.

  • New file geodatabase—The data will be replicated to a new file geodatabase that will be created when the tool is run. Provide the location and name of the new file geodatabase in the File geodatabase location parameter. This option is only valid for one-way and checkout replicas.

String

XML file to replicate data to

(Optional)

The name and location of the .xml file that will be created.

This parameter is required if the Output Type parameter is set to Xml file.

File

All records for tables

(Optional)

Specifies whether all records or only the schema will be copied to the child geodatabase for tables that do not have filters applied (such as selections or definition queries).

Tables with applied filters will be honored.

  • Checked—For tables with no applied filters, all records will be copied to the child geodatabase. This option will override the expand_feature_classes_and_tables parameter value.

  • Unchecked—For tables with no applied filters, only the schema will be copied to the child geodatabase. Tables with applied filters will be honored. This is the default.

Boolean

File geodatabase location

(Optional)

The location of the file geodatabase that will be created to host the child replica. This parameter is required if the Output Type parameter is set to New file geodatabase and is only valid for one-way and checkout replicas.

Folder

File geodatabase name

(Optional)

The name of the file geodatabase that will be created to host the child replica. This parameter is required if the Output Type parameter is set to New file geodatabase and is only valid for one-way and checkout replicas.

String

Geometry Filter Type

(Optional)

Specifies the spatial relationship between the Replica Datasets and Replica Geometry Features parameter values. The spatial relationship is applied to data in an extent defined by the Replica Geometry Features parameter value.

  • Contains—Features in the Replica Datasets parameter value that are contained by the selected feature in the Replica Geometry Features parameter value will be extracted.

  • Intersects—Features in the Replica Datasets parameter value that intersect features in the Replica Geometry Features parameter value will be extracted. This is the default.

String

Replicate

(Optional)

Specifies whether the Replica Datasets parameter value will be replicated with all features or using the schema only.

The parameter is available when the Replica Type parameter value is a check out replica.

  • Data—The features from the Replica Datasets parameter value will be included in the output replica. This is the default.

  • Schema Only—Only the schema for the Replica Datasets parameter value will be added to the output replica.

String

Derived output

Label Explanation Data type

Output Child Workspace

The output child geodatabase.

Workspace

Output Replica Name

The name of the output replica.

String

Environments

Current Workspace, Output CONFIG Keyword, Extent, Scratch Workspace

Licensing information

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