Check Out File

摘要

Checks out a file from a Product Library.

产品库存储着在地理数据库中进行制图和数字数据生产时所需的信息和数据。Esri Mapping and Charting solutions 在产品库内存储业务规则、文档和空间信息。

You must check out a file to edit it.

用法

• Check out locks a file. A file can only be checked out by one person.

• 产品库工作空间必须是地理数据库。

• 该产品库文件路径为特殊“产品库”树结点的路径。此产品库路径为采用以下格式的双冒号分隔的字符串 (::)：解决方案名称::产品类名称::系列名称::产品名称::实例名称::AOI 名称::文件名称。

• 要确定产品库路径，导航到产品库窗口中的项目，右键单击它，然后选择复制为路径。该产品库路径将被放置到剪贴板中。您可以将其粘贴到需要产品库路径的任何参数中。

• Check out creates a local copy of the file in the location indicated by Checkout path. Checkout path must be a folder.

• This tool returns a path as a string to the checked out file. If you are going to check out a file or personal geodatabase (an instance database) by executing tools in ModelBuilder, use the Check Out File As File tool instead of this tool. Check Out File As File returns a file while this tool returns a string.

• If you use this tool in ModelBuilder, insert the Calculate Value tool to convert the returned string to another data type. For example, given a model that checks out an instance database, executes Upgrade Production Database, then checks the instance database back into a product library, you need to connect Check Out File to Calculate Value through a precondition. Calculate Value can convert the string returned by Check Out File to a workspace. The model would look similar to the following image:

  

  The expression r"%Path to checked out file%" is the output data variable of Check Out File. Calculate Value converts this string into the data type listed in the Data type field. The dashed line connecting the output data variable to Calculate Value indicates that Path to checked out file is a precondition in Calculate Value. You can then connect the Calculate Value output data variable (workspace) to the Upgrade Production Database tool.

语法

PLCheckoutFile(product_library_workspace, product_library_itempath, checkout_location, {overwrite_flag}, {product_library_ownername})

参数	说明	数据类型
product_library_workspace	产品库工作空间的路径。	Workspace
product_library_itempath	项目的产品库路径。按照以下格式指定路径：解决方案名称::产品类名称::系列名称::产品名称::实例名称::AOI 名称::文件名称。	String
checkout_location	The folder that will contain the checked out file.	Folder
overwrite_flag (可选)	Indicates whether the checkout process overwrites a local copy of the file if it exists. DO_NOT_OVERWRITE —Do not overwrite an existing local copy of the file. This is the default. OVERWRITE —Overwrite an existing local copy of the file.	Boolean
product_library_ownername (可选)	产品库方案所有者名称。如果 product_library_workspace 中指定的用户帐户不是方案所有者，请设置此参数。这仅适用于存储在企业级地理数据库中的产品库。	String

代码示例

PLCheckoutFile example (stand-alone script)

The following stand-alone script demonstrates how to check out a file from a Product Library.

# Name: CheckOutFile_Example.py
# Description: Checks out a file from a Product Library
# Requirements: Production Mapping extension

# import arcpy and checkout a Production Mapping license
import arcpy
arcpy.CheckOutExtension("foundation")

#Set local variables
product_library_workspace = "C:\\Data\\ProductLibrary.gdb"
product_library_itempath = "Products::Topographic Maps::QA_QC_carto_checklist.rtf"
checkout_location = "C:\\Data"
overwrite_flag = "OVERWRITE"

# create a production database
arcpy.PLCheckoutFile_production(product_library_workspace, product_library_itempath, checkout_location, overwrite_flag)

print "Script completed successfully."

# Check in the extension
arcpy.CheckInExtension("foundation")

PLCheckoutFile example 2 (Python window)

The following Python window script checks out a database .mdf and attaches it to an instance of SQLExpress.

import arcpy, os

# variables for PLCheckOutFile params
productLibrary="c:\\data\\ProductLibrary.gdb"
plPath="Products::Topographic Maps::QA_QC_carto.mdf"
checkOutFolder="c:\\data"

# variable for AttachDatabase tool
sqlExpress="YOUR_SERVER_NAME\\SQLEXPRESS"

# exec PLCheckOutFile
result=arcpy.PLCheckoutFile_production(productLibrary, plPath, checkOutFolder)

# result[0] contains the path to the checked out file
mdf=result[0]
if os.path.exists(mdf):
    print mdf

    # use mdf in Attach Database
    result=arcpy.AttachDatabase_production(sqlExpress,mdf)

    # print out the database name
    print result[0]
    print "Script completed successfully"

环境

• 当前工作空间

许可信息

• ArcGIS Desktop Basic: 否
• ArcGIS Desktop Standard: 需要 Production Mapping
• ArcGIS Desktop Advanced: 需要 Production Mapping