ParseColumnName Method

In This Topic

Given a column name (fully qualified or otherwise), determines its qualification parts. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public Tuple<string,string,string,string> ParseColumnName( 
   string columnFullName
)

Public Function ParseColumnName( _
   ByVal columnFullName As String _
) As Tuple(Of String,String,String,String)

Parameters

columnFullName: The fully qualified name of the column. It must not be null or an empty string.

Return Value

A Tuple whose members contain the following data:

Item1 holds the databaseName (or an empty string if it doesn't apply to the underlying Datastore).
Item2 holds the ownerName (or an empty string if it doesn't apply to the underlying Datastore).
Item3 holds the tableName.
Item4 holds the columnName.

Exceptions

Exception	Description
System.ArgumentException	columnFullName is null or an empty string.
ArcGIS.Core.Data.Exceptions.GeodatabaseEnterpriseException	With the error message `The specified parameter value is invalid` if columnFullName contains a databaseName component when the underlying Datastore is an enterprise geodatabase on Oracle.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.

Remarks

Applications should use the ParseColumnName method to split the fully qualified name for a column in a table into its components (database, owner, table, column).

Applications that wish to be RDBMS independent should not assume that '.' is the delimiter used to separate the components of a fully qualified dataset name. Use the QualifyColumnName method to determine the qualified name of a column of a table for a given Datastore.

Empty strings will be returned for arguments that do not apply to the underlying Datastore. For example, supplying a columnFullName argument of "gdb.Greeley_Parcels_1.AREA" to an enterprise geodatabase on Oracle will result in:

databaseName = ""
ownerName = "gdb"
tableName = "Greeley_Parcels_1"
columnName = "AREA"

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

SQLSyntax Class
SQLSyntax Members

Send feedback