com.esri.arcgis.geodatabasedistributed
Interface IExportSchema

All Superinterfaces:

Serializable

All Known Implementing Classes:

ReplicaSchemaExporter

public interface IExportSchema
extends Serializable

Provides access to members that export schema from a replica.

Remarks

The IExportdataSchema interface provides methods to export schema and schema differences from replicas.

Rule: If a replica can receive data changes, then it can also apply schema changes. Replica schema can only be exported from a replica that can synchronize it's changes with it's relative replica.

Consider the statements above when reviewing the following:

Check-out Replicas: A check-out child replica can export replica schema but cannot apply schema changes. A check-out parent replica can apply schema changes but cannot export replica schema.

One way Replicas: A one way replica child cannot export replica schema but can apply schema changes. A one way replica parent can export replica schema but cannot apply schema changes

Two way Replicas: Both parent and child replicas can export replica schema and apply schema changes.

See the ReplicaSchemaImporter for information on applying schema changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	exportSchema(String exportFileName, IReplica replica) Export schema info.
void	exportSchemaDifferences(String exportFileName, ISchemaChanges schemaChanges) Export schema differences between replica pair.

Method Detail

exportSchema

void exportSchema(String exportFileName,
                  IReplica replica)
                  throws IOException,
                         AutomationException

Export schema info.

Remarks

The ExportSchema method exports a replicas schema to an XML file.

ExportFileName is the XML file to be created and Replica defines the replica from which to export the schema.

The exportFileName is the string name of the replica schema changes file (XML) that will be created. The Replica parameter takes a Replica object for the replica to export the schema from. See the Replica coclass for more information.

Replica schema cannot be exported from check-out parent replicas or one way child replicas. All other replica types are supported.

Replica schema can only be exported from a replica that can synchronize it's changes with it's relative replica. This includes check-out replicas (child replicas only), two way replicas (both parent and child replicas), and one way parent replicas. Ultimately, this replica schema document can be used to compare and import schema differences into the relative replica. If a relatives replica cannot receive data changes, it also can not apply schema changes. Therefore we do not allow exporting replica schema in the first place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

exportFileName - The exportFileName (in)

replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportSchemaDifferences

void exportSchemaDifferences(String exportFileName,
                             ISchemaChanges schemaChanges)
                             throws IOException,
                                    AutomationException

Export schema differences between replica pair.

Remarks

The ExportSchemaDifferences method exports replica schema differences to an XML file.

The exportFileName is the string name of the replica schema changes file (XML) that will be created. The SchemaChanges parameter takes a reference to a SchemaChanges object. See the SchemaChanges coclass for more information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

exportFileName - The exportFileName (in)

schemaChanges - A reference to a com.esri.arcgis.geodatabasedistributed.ISchemaChanges (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.