ArcMap

Check Out

Summary

Creates a check-out replica from datasets in an ArcSDE geodatabase to an ArcSDE, file, or personal geodatabase for offline editing.

Usage

  • The tool accepts layers or tables that reference data from one ArcSDE server. Either add them to the list in the dialog box or create a semicolon-delimited list at the command line or in a script.

  • The layers and tables must reference versioned ArcSDE feature classes and tables for which you have permissions to edit.

  • The following describes how to define the rows to check out:

    • The geoprocessing environment output extent setting is used as the spatial extent for the replicated data. Only features intersecting this extent are considered for the replica.
    • Definition queries and selections on individual layers and in tables can also be used to define the rows to replicate.
    • A combination of these may be applied. For example, if there is an output extent defined and a layer has a selection set, only selected features that intersect the extent are replicated.
    • Definition queries can be defined using table or layer properties in ArcMap or using the Make Feature Layer and Make Table View tools. Selections applied to layers and tables in ArcMap will also be used. Selections and definition queries can also be persisted for layers in layer files.
    • Layers and tables in ArcMap or created using the Make Feature Layer and Make Table View tools can be added using a drop-down list in the tool. The layers and tables must be referenced by name on the command line. Layer files can be added using drag-and-drop or the Add Data button.
    • If you add data directly from the ArcSDE connection in the dialog box, a definition query or selection will not be applied.
    • For cases where there is no output extent, definition query, or selection, all data in a feature class is replicated. In a table, only schema is replicated.
    • If one feature class from a feature dataset is included in the replica, all data in the feature dataset is also replicated. Only the output extent will be applied to the other classes in the feature dataset. To apply a definition query or a selection set, layers or tables must be added explicitly to the tool.

  • This tool applies the default behavior of the create replica command in ArcMap.

  • If the Check-out to Workspace parameter value is a personal or file geodatabase that does not exist, one will be created.

  • Once replicated, edits may be applied to the child replica geodatabase and synchronized with the parent geodatabase.

Syntax

arcpy.management.Checkout(in_data, {in_type}, out_workspace, out_name, {reuse_schema}, {get_related_data})
ParameterExplanationData Type
in_data
[in_data,...]

The data to be replicated for offline editing. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

Feature Layer; Table View
in_type
(Optional)

Specifies if the data and schema will be replicated or if a SCHEMA-ONLY check-out of the database should occur. The default is DATA.

  • DATA —The data and the schema will be replicated. This is the default.
  • SCHEMA_ONLY —Only the schema will be replicated.
String
out_workspace

The workspace where the replicated data will be edited. This can be an ArcSDE, file, or personal geodatabase. If it's a personal geodatabase that doesn't exist, it will be created.

Workspace
out_name

The name that identifies the check-out replica. This is recorded and maintained in both the parent and the child database until synchronized.

String
reuse_schema
(Optional)

Choose REUSE if you are using a database with the schema (no data) as the out_workspace. REUSE will be faster, since a schema will not need to be created during replica creation. The default is NO_REUSE.

  • NO_REUSE —Do not reuse the schema. This is the default.
  • REUSE —Reuse the schema.
Boolean
get_related_data
(Optional)

Specifies whether to replicate related data that has established relationships with the replicated data. For example, consider a feature (f1) inside the replica area and a related feature (f2) from another class outside the replica area. Feature f2 is included in the check-out replica if you choose to get related data.

  • RELATED —Replicate related data. This is the default.
  • NO_RELATED —Do not replicate related data.
Boolean

Code sample

CheckOut Example (Python Window)
import arcpy
from arcpy import env
env.workspace = "C:/Data/MySDEdata.sde"
arcpy.Checkout_management("roads", "DATA", "C:/Data/MyCheckout.gdb", "mycheckout1", "REUSE", "RELATED")

Environments

Licensing information

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