root/MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Directories.Directory.CopyTable.html @ 316

Revision 316, 12.9 KB (checked in by jjr8, 5 years ago)

Built MGET 0.7a1. Forgot to mention that the checkin before the last one also fixed #308: When a GAM uses the loess function (lo) and is fitted with the R gam package, Predict GAM fails when rasters include NODATA values.

This will be merged into Trunk and released as MGET 0.7a1.
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>CopyTable Method</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /><style xml:space="preserve">
4            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; }
5            td.metadataValue { padding-left: 0.5em; }
6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CopyList Method" href="Method_GeoEco.DataManagement.Directories.Directory.CopyList.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Directory Class" href="Class_GeoEco.DataManagement.Directories.Directory.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Create Method" href="Method_GeoEco.DataManagement.Directories.Directory.Create.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Directories.Directory.CopyList.html?format=raw">CopyList Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Directories.Directory.html?format=raw">Directory Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Directories.Directory.Create.html?format=raw">Create Method</a> </div><hr /></div></div><h1><tt class="member">CopyTable</tt> Method</h1><p>Copies the directories listed in a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Directories.Directory.html?format=raw">Directory</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">Directory.CopyTable</tt></b>(</td><td><var>connection</var><var>, table</var><var>, sourceDirectoryField</var><var>, destinationDirectoryField</var><big>[</big><var>, where</var><big>[</big><var>, orderBy</var><big>[</big><var>, directions</var><big>[</big><var>, skipExisting</var><big>[</big><var>, basePath</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">GeoEco.DatabaseAccess.DatabaseConnection</tt></td></tr></table><p>Connection opened to the database that contains the table.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the table to query.</p></dd></dl><dl><dt><var>sourceDirectoryField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field containing the paths of the directories to copy.</p><p>The directories may contain subdirectories and files. Other types of
7file system objects, such as symbolic links, are not allowed.</p></dd></dl><dl><dt><var>destinationDirectoryField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field containing the paths of the destination directories.</p></dd></dl><dl><dt><var>where</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause expression that specifies the subset of rows to
8process. If this parameter is not provided, all of the rows will be
9processed. If this parameter is provided but the underlying database
10does not support WHERE clauses, an error will be raised.</p><p>The exact syntax of this expression depends on the underlying database
11and the type of connection used to access it. If you are using the
12ArcGIS geoprocessor to access the database, ESRI recommends you
13reference fields using the following syntax:</p><ul><li>If you're querying ArcInfo coverages, shapefiles, INFO tables or
14dBASE tables (.dbf files), enclose field names in double quotes in
15the SQL expression: "MY_FIELD".</li><li>If you're querying Microsoft Access tables or personal
16geodatabase tables, enclose field names in square brackets:
17[MY_FIELD].</li><li>If you're querying ArcSDE geodatabase tables, an ArcIMS feature
18class, or an ArcIMS image service sublayer, don't enclose field
19names: MY_FIELD.</li></ul></dd></dl><dl><dt><var>orderBy</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">0</td></tr></table><p>Fields that will be used to sort the rows (i.e., the columns
20specified in the ORDER BY clause of a SQL SELECT statement). If no
21fields are provided, the rows will be sorted in the default order
22determined by the underlying database. If this parameter is provided
23but the underlying database does not support ORDER BY clauses, an
24error will be raised.</p><p>In addition to specifying the ORDER BY fields, you must also specify
25the sort direction for each field.</p></dd></dl><dl><dt><var>directions</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">0</td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify
26the sort directions for the ORDER BY fields. If this parameter is
27provided but the underlying database does not support ORDER BY
28clauses, an error will be raised.</p></dd></dl><dl><dt><var>skipExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, copying will be skipped for destination directories that already exist.</p></dd></dl><dl><dt><var>basePath</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Base path to prepend to relative paths.</p><p>If any of the input paths (or output paths, if this method has
29outputs) obtained from the table are relative paths, they will be
30converted to absolute paths prior to processing, as follows:</p><ul><li>If a base path is provided, it will be prepended to the relative
31path.</li><li>Otherwise, if the ArcGIS geoprocessor has been initialized and the
32geoprocessing workspace has been set (i.e. the Workspace property of
33the geoprocessor is not empty), it will be prepended to the relative
34path.</li><li>Otherwise, the current working directory for the executing process
35will be prepended to the path. If you have not explicitly changed
36the working directory, it is usually the directory that contains the
37Python interpreter (e.g., on Windows computers, it would be
38C:\Python24, if you're running Python 2.4).</li></ul></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CopyList Method" href="Method_GeoEco.DataManagement.Directories.Directory.CopyList.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Directory Class" href="Class_GeoEco.DataManagement.Directories.Directory.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Create Method" href="Method_GeoEco.DataManagement.Directories.Directory.Create.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Directories.Directory.CopyList.html?format=raw">CopyList Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Directories.Directory.html?format=raw">Directory Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Directories.Directory.Create.html?format=raw">Create Method</a> </div><hr /><span class="release-info">Marine Geospatial Ecology Tools version 0.7a1</span></div></div></body></html>
Note: See TracBrowser for help on using the browser.