GeoEco.DataManagement.Directories.Directory.DeleteArcGISTable

classmethod Directory.DeleteArcGISTable(table, directoryField, removeTree=False, where=None, orderBy=None, basePath=None)

Deletes the directories listed in a table.

Requires: ArcGIS Pro 3.2.0 or later or ArcGIS Server equivalent to ArcGIS Pro 3.2.0 or later.

Parameters:

  • table (str) – Table to query. Minimum length꞉ 1. Must exist.

  • directoryField (str) – Field containing the paths of the directories to delete. Minimum length꞉ 1.

  • removeTree (bool, optional) – If True, all files and subdirectories contained in the directory will be deleted. If False, the directory must be empty or deletion will fail.

  • where (str, optional) –

    SQL WHERE clause expression that specifies the rows to include. If not provided, all of the rows will be included. If provided but the underlying storage format does not support WHERE clauses, an exception will be raised.

    The exact syntax of this expression depends on the underlying storage format. If the underlying data store will be accessed through ArcGIS, this article may document some of the possible syntax, but not all of it may be supported through ArcGIS’s underlying Python API.

    Minimum length꞉ 1.

  • orderBy (str, optional) –

    SQL ORDER BY clause that specifies the order in which the rows should be accessed. If not provided, the rows will accessed according to the default behavior of the underlying storage format and the programming library used to access it.

    The ORDER BY clause must be a comma-separated list of fields. Each field can optionally be followed by a space and the word ASC to indicate ascending order or DESC to indicate descending order. If neither is specified, ASC is assumed.

    The underlying storage format and library perform the actual evaluation of this parameter and determine the rules of sorting, such as whether string comparisons are case-sensitive or case-insensitive. At present, there is no mechanism to interrogate or manipulate these rules; you must live with the default behavior of the underlying format and library.

    Minimum length꞉ 1. Must match regular expression꞉ \s*\S+(\s+([aA][sS][cC]|[dD][eE][sS][cC]))?\s*(,\s*\S+(\s+([aA][sS][cC]|[dD][eE][sS][cC]))?\s*)*.

  • basePath (str, optional) –

    Base path to prepend to relative paths.

    If a base path is provided, it will be prepended to any relative paths that are obtained from the fields that list the inputs (and outputs, if this tool has outputs). If a base path is not provided, the workspace containing the table will be prepended instead. Minimum length꞉ 1.

Returns:

Processed table.

Return type:

str