サマリー
Provides access to basic table properties and methods.
説明
There are two ways tables can be referenced in a script for use in a project. To reference tables already in a project, use the listTables method on the Map class. To reference tables directly from a workspace, use the Table function.
You may want to reference a table in a project using the listTables function, because you may need to change a table's data source or definition query, or even remove the table from the project using the removeTable method.
The Table function is useful for referencing new tables you want to add into a project. Once you have a reference to a new, external table source, you can add it to a Map using the addTable method.
A table can support zero to many definition queries, but only one definition query can be active. It is also possible that one or many definition queries are present but none are active. There are a couple of ways to manage definition queries. First, you can use the definitionQuery property. If you set a unique SQL string on a table that does not have a definition query or a table that has multiple definition queries, the new definition query is added and it becomes the active query. If you set a SQL string on a table that already has that same query, it sets that as the active definition query, if it is not already active. The second way to manage definition queries is to use the listDefinitionQueries and updateDefinitionQueries functions in combination. The listDefinitionQueries function returns a list of Python dictionaries that represent the properties associated with each query. The dictionary keys are name, sql, and isActive. Definition queries can be added, modified, or removed from the Python list using core Python. The dictionary isActive value can be set to True to set the active query. Again, only one query can be active. If you try setting more than one query to be active, an error will be returned. After changes are made, the updateDefinitionQueries function is used to set the new changes.
Changing a tables's data source is a common requirement. There is a method and a property on the Layer object that help with this. For a more detailed discussion, parameter information, scenarios, and code samples, refer to the Updating and fixing data sources help topic.
プロパティ
| プロパティ | 説明 | データ タイプ |
| connectionProperties (読み取り専用) | Returns a table's data source connection information as a Python dictionary. | Dictionary |
| dataSource (読み取り専用) | Returns the complete path for the table's data source. It includes the full workspace path and name of the dataset. For enterprise geodatabase tables, a string containing the table's connection information is returned. ヒント:Enterprise geodatabase tables in an ArcGIS Pro project do not retain the path to the database connection file (.sde) that was used to create the layer. | String |
| definitionQuery (読み書き) | Provides the ability to get or set a tables's definition query. | String |
| isBroken (読み取り専用) | Returns True if a table's data source is broken. | Boolean |
| longName (読み取り専用) | A table's full path and name including group layers. | String |
| metadata (読み書き) | Get or set the table's Metadata class information. 注意:Setting metadata is dependent on the isReadOnly property value. | Metadata |
| name (読み書き) | Provides the ability to set or get the name of a table the way it would appear in the table of contents. Spaces can be included. | String |
| URI (読み取り専用) | The Universal Resource Indicator for a table. It is a unique identifier for a table in a project and is sometimes required when using Python CIM access. Once a table is added and the URI is established, the value does not change over time. For example, if you modify the table's name, the URI will not change. | String |
方法の概要
| 方法 | 説明 |
| getDefinition (cim_version) | Gets a table's CIM definition. |
| getSelectionSet () | Returns a table's selection as a Python set of Object IDs. |
| listDefinitionQueries ({wildcard}) | Returns a Python list of definition queries associated with a table. |
| saveACopy (file_name) | Saves a table to a layer file (.lyrx). |
| setDefinition (definition_object) | Sets a table's CIM definition. |
| setSelectionSet ({oidList}, {method}) | Sets a table's selection using a Python list of Object IDs. |
| updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case}) | The updateConnectionProperties method replaces connection properties using a dictionary or a path to a workspace. |
| updateDefinitionQueries (definitionQueries) | Updates a table's collection of definition queries. |
方法
getDefinition (cim_version)
| パラメーター | 説明 | データ タイプ |
cim_version | A string that represents the major version of the CIM. | String |
CIM-level access to additional object properties was introduced at ArcGIS Pro 2.4. When you want to return an object's CIM definition, you must specify a cim_version. Esri follows the semantic versioning specification. This means that at major releases—for example, 3.0—breaking API changes are allowed. This allows Python script authors control over which version of the CIM is used during a script run if there is a possibility breaking changes may be introduced in the new version. If you are authoring scripts for ArcGIS Pro 2.x, specify the cim_version to be 'V2'. If you are authoring scripts for ArcGIS Pro 3.x, specify the cim_version to be 'V3'. Scripts authored using cim_version 'V2' will continue to work in ArcGIS Pro 3.x.
For more information about working with the CIM and samples, see Python CIM access.
getSelectionSet ()
| データ タイプ | 説明 |
| List | Returns a table's selection as a Python set of Object IDs. |
Provides an easy way to retrieve the table's current selection.
listDefinitionQueries ({wildcard})| パラメーター | 説明 | データ タイプ |
wildcard | A wildcard is based on the query name and is not case sensitive. A combination of asterisks (*) and characters can be used to limit the resulting list. (デフォルト値は次のとおりです None) | String |
| データ タイプ | 説明 |
| List | A Python list of dictionaries that represent the properties associated with each query. The dictionary keys are name, sql, and isActive. |
Definition queries can be added, modified, or removed from the Python list using standard practices. The dictionary isActive value can be set to True to set the active query. Again, only one query can be active. If you try setting more than one query to be active, an error will be returned. After changes are made, the updateDefinitionQueries function is used to set the new changes.
saveACopy (file_name)
| パラメーター | 説明 | データ タイプ |
file_name | A string that includes the location and name of the output layer file (.lyrx). | String |
Both tables and layers can be saved to the layer file (.lyrx).
setDefinition (definition_object)
| パラメーター | 説明 | データ タイプ |
definition_object | A modified CIM definition object originally retrieved using getDefinition. | Object |
For more information about working with the CIM and samples, see Python CIM Access.
setSelectionSet ({oidList}, {method})| パラメーター | 説明 | データ タイプ |
oidList [oidList,...] | A Python list of Object IDs to use along with the appropriate selection method. (デフォルト値は次のとおりです None) | List |
method | A string that specifies which selection method to use.
(デフォルト値は次のとおりです NEW) | String |
This method provides an easy way to manage a table's selection. To clear the selection, use the NEW selection method with an empty list or don't set any parameters. Python lists are used for the oidList, but sets get returned from the getSelectionSet method on the Table object.
updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})| パラメーター | 説明 | データ タイプ |
current_connection_info | A string that represents the workspace path or a Python dictionary that contains connection properties to the source you want to update. If an empty string or None is used in current_connection_info, all connection properties will be replaced with the new_workspace_info, depending on the value of the validate parameter. | String |
new_connection_info | A string that represents the workspace path or a Python dictionary that contains connection properties with the new source information. | String |
auto_update_joins_and_relates | If set to True, the updateConnectionProperties method will also update the connections for associated joins or relates. (デフォルト値は次のとおりです True) | Boolean |
validate | If set to True, the connection properties will only be updated if the new_connection_info value is a valid connection. If it is not valid, the connection will not be replaced. If set to False, the method will set all connections to match the new_connection_info value, regardless of a valid match. In this case, if a match does not exist, the data sources would be broken. (デフォルト値は次のとおりです True) | Boolean |
ignore_case | Determines whether searches will be case sensitive. By default, queries are case sensitive. To perform queries that are not case sensitive, set ignore_case to True. (デフォルト値は次のとおりです False) | Boolean |
For more detailed discussion, parameter information, scenarios, and code samples, see Updating and fixing data sources.
updateDefinitionQueries (definitionQueries)
| パラメーター | 説明 | データ タイプ |
definitionQueries [definitionQueries,...] | Updates a list of dictionaries that represent the properties of each definition query for a table. | List |
This function is typically used to apply the changes that have been made to the results returned by the listDefinitionQueries function.
コードのサンプル
The following script prints the stand-alone table names that have a broken data source for all tables in all maps:
import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")
for m in aprx.listMaps():
for tbl in m.listTables():
if tbl.isBroken:
print(f"Table: {tbl.name} is broken in map: {m.name}")
del aprxThe following script adds a table from a file geodatabase into a map:
import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\YosemiteNP\Yosemite.aprx")
addTab = arcpy.mp.Table(r"C:\Projects\YosemiteNP\Data_Vector\YosemiteData.gdb\NHDFCode")
m = aprx.listMaps("Yose*")[0]
m.addTable(addTab)
del aprx