Querying workspace properties

In this topic

• Workspace properties
• Geodatabase release information
• Configuration keywords
• Database connection information
• Determining if a workspace is an enterprise geodatabase

Workspace properties

• Those that indicate the capabilities of the workspace
• Those that indicate the capabilities of tables in the workspace

public int GetMaximumFieldNameLength(IWorkspace workspace)
{
    // Get the workspace property.
    IWorkspaceProperties workspaceProperties=workspace as IWorkspaceProperties;
    if (workspaceProperties == null)
    {
        throw new ArgumentException(
            "Workspace does not implement IWorkspaceProperties.");
    }
    IWorkspaceProperty workspaceProperty=workspaceProperties.get_Property
        (esriWorkspacePropertyGroupType.esriWorkspaceTablePropertyGroup, (int)
        esriWorkspaceTablePropertyType.esriTablePropMaxFieldNameLength);

    // See if the property is supported.
    if (workspaceProperty.IsSupported)
    {
        // Get the property value.
        object propertyValue=workspaceProperty.PropertyValue;
        return Convert.ToInt32(propertyValue);
    }
    else
    {
        throw new Exception("The esriTablePropMaxFieldNameLength property is " + 
            "not supported by this workspace.");
    }
}

Public Function GetMaximumFieldNameLength(ByVal workspace As IWorkspace) As Integer
    ' Get the workspace property.
    Dim workspaceProperties As IWorkspaceProperties=TryCast(workspace, IWorkspaceProperties)
    If workspaceProperties Is Nothing Then
        Throw New ArgumentException("Workspace does not implement IWorkspaceProperties.")
    End If
    Dim workspaceProperty As IWorkspaceProperty=workspaceProperties.Property _
                                                  (esriWorkspacePropertyGroupType.esriWorkspaceTablePropertyGroup, _
                                                  CInt(esriWorkspaceTablePropertyType.esriTablePropMaxFieldNameLength))
    
    ' See if the property is supported.
    If workspaceProperty.IsSupported Then
        ' Get the property value.
        Dim propertyValue As Object=workspaceProperty.PropertyValue
        Return CInt(propertyValue)
    Else
        Throw New Exception("The esriTablePropMaxFieldNameLength property is " + _
                            "not supported by this workspace.")
    End If
End Function

Geodatabase release information

public void UpgradeGeodatabase(IWorkspace workspace)
{
    // Display the current version of the geodatabase.
    IGeodatabaseRelease2 gdbRelease=(IGeodatabaseRelease2)workspace;
    Console.WriteLine("GDB release: {0}.{1}.{2}", gdbRelease.MajorVersion,
        gdbRelease.MinorVersion, gdbRelease.BugfixVersion);
    if (gdbRelease.CurrentRelease)
    {
        Console.WriteLine("This geodatabase is current with the client.");
    }
    else
    {
        Console.WriteLine("This geodatabase is not current with the client.");

        // Try to upgrade the geodatabase.
        if (gdbRelease.CanUpgrade)
        {
            try
            {
                Console.WriteLine("Upgrading the geodatabase...");
                gdbRelease.Upgrade();
                Console.WriteLine("The new GDB release: {0}.{1}.{2}",
                    gdbRelease.MajorVersion, gdbRelease.MinorVersion,
                    gdbRelease.BugfixVersion);
            }
            catch (COMException comExc)
            {
                Console.WriteLine("Upgrading the geodatabase failed:");
                Console.WriteLine("{0} ({1})", comExc.Message, comExc.ErrorCode);
            }
        }
        else
        {
            Console.WriteLine("The geodatabase could not be upgraded.");
        }
    }
}

Public Sub UpgradeGeodatabase(ByVal workspace As IWorkspace)
    ' Display the current version of the geodatabase.
    Dim gdbRelease As IGeodatabaseRelease2=CType(workspace, IGeodatabaseRelease2)
    Console.WriteLine("GDB release: {0}.{1}.{2}", gdbRelease.MajorVersion, _
                      gdbRelease.MinorVersion, gdbRelease.BugfixVersion)
    If gdbRelease.CurrentRelease Then
        Console.WriteLine("This geodatabase is current with the client.")
    Else
        Console.WriteLine("This geodatabase is not current with the client.")
        
        ' Try to upgrade the geodatabase.
        If gdbRelease.CanUpgrade Then
            Try
            Console.WriteLine("Upgrading the geodatabase...")
            gdbRelease.Upgrade()
            Console.WriteLine("The new GDB release: {0}.{1}.{2}", _
                              gdbRelease.MajorVersion, gdbRelease.MinorVersion, _
                              gdbRelease.BugfixVersion)
            Catch comExc As COMException
            Console.WriteLine("Upgrading the geodatabase failed:")
            Console.WriteLine("{0} ({1})", comExc.Message, comExc.ErrorCode)
            End Try
        Else
            Console.WriteLine("The geodatabase could not be upgraded.")
        End If
    End If
End Sub

Configuration keywords

public void DisplayConfigurationKeywords(IWorkspace workspace)
{
    // Get a configuration keyword enumerator.
    IWorkspaceConfiguration workspaceConfig=(IWorkspaceConfiguration)workspace;
    IEnumConfigurationKeyword enumConfigKeyword =
        workspaceConfig.ConfigurationKeywords;
    enumConfigKeyword.Reset();

    // Iterate through the configuration keywords.
    IConfigurationKeyword configKeyword=null;
    while ((configKeyword=enumConfigKeyword.Next()) != null)
    {
        // Display the keyword properties.
        Console.WriteLine("Name: {0}", configKeyword.Name);
        Console.WriteLine("Type: {0}", configKeyword.KeywordType);
        Console.WriteLine("Description: {0}", configKeyword.Description);
        Console.WriteLine("Comments: {0}", configKeyword.Comments);

        // Iterate through the keyword parameters.
        IEnumConfigurationParameter enumConfigParameter =
            configKeyword.ConfigurationParameters;
        enumConfigParameter.Reset();
        IConfigurationParameter configParameter=null;
        while ((configParameter=enumConfigParameter.Next()) != null)
        {
            Console.WriteLine("Parameter: {0} ({1})", configParameter.Name,
                configParameter.ConfigurationString);
        }
    }
}

Public Sub DisplayConfigurationKeywords(ByVal workspace As IWorkspace)
    ' Get a configuration keyword enumerator.
    Dim workspaceConfig As IWorkspaceConfiguration=CType(workspace, IWorkspaceConfiguration)
    Dim enumConfigKeyword As IEnumConfigurationKeyword=workspaceConfig.ConfigurationKeywords
    enumConfigKeyword.Reset()
    
    ' Iterate through the configuration keywords.
    Dim configKeyword As IConfigurationKeyword=enumConfigKeyword.Next()
    While Not configKeyword Is Nothing
        ' Display the keyword properties.
        Console.WriteLine("Name: {0}", configKeyword.Name)
        Console.WriteLine("Type: {0}", configKeyword.KeywordType)
        Console.WriteLine("Description: {0}", configKeyword.Description)
        Console.WriteLine("Comments: {0}", configKeyword.Comments)
        
        ' Iterate through the keyword parameters.
        Dim enumConfigParameter As IEnumConfigurationParameter=configKeyword.ConfigurationParameters
        enumConfigParameter.Reset()
        Dim configParameter As IConfigurationParameter=enumConfigParameter.Next()
        While Not configParameter Is Nothing
            Console.WriteLine("Parameter: {0} ({1})", configParameter.Name, configParameter.ConfigurationString)
            configParameter=enumConfigParameter.Next()
        End While
        
        configKeyword=enumConfigKeyword.Next()
    End While
End Sub

Database connection information

public void DisplayConnectionInfo(IWorkspace workspace)
{
    IDatabaseConnectionInfo2 connectionInfo=(IDatabaseConnectionInfo2)workspace;
    Console.WriteLine("Server: {0}", connectionInfo.ConnectionDBMS);
    Console.WriteLine("User: {0}", connectionInfo.ConnectedUser);
    Console.WriteLine("Database: {0}", connectionInfo.ConnectedDatabase);
    Console.WriteLine("DBMS: {0}", connectionInfo.ConnectionDBMS);
    Console.WriteLine("Server Class: {0}", connectionInfo.GeodatabaseServerClass);
}

Public Sub DisplayConnectionInfo(ByVal workspace As IWorkspace)
    Dim connectionInfo As IDatabaseConnectionInfo2=CType(workspace, IDatabaseConnectionInfo2)
    Console.WriteLine("Server: {0}", connectionInfo.ConnectionDBMS)
    Console.WriteLine("User: {0}", connectionInfo.ConnectedUser)
    Console.WriteLine("Database: {0}", connectionInfo.ConnectedDatabase)
    Console.WriteLine("DBMS: {0}", connectionInfo.ConnectionDBMS)
    Console.WriteLine("Server Class: {0}", connectionInfo.GeodatabaseServerClass)
End Sub

Determining if a workspace is an enterprise geodatabase

public bool IsConnectedToGeodatabase(IWorkspace workspace)
{
    // The following code will use the workspace properties to determine if the workspace is an enterprise geodatabase or a database.
    IWorkspaceProperties workspaceProperties=(IWorkspaceProperties)workspace;
    IWorkspaceProperty isGDBProperty=workspaceProperties.get_Property
        (esriWorkspacePropertyGroupType.esriWorkspacePropertyGroup, (int)
        esriWorkspacePropertyType.esriWorkspacePropIsGeoDatabase);
    object isGDB=isGDBProperty.PropertyValue;
    Boolean isGeodatabase=Convert.ToBoolean(isGDB);
    return isGeodatabase;
}

Public Function IsConnectedToGeodatabase(ByVal workspace As ESRI.ArcGIS.Geodatabase.IWorkspace) As Boolean
    'The following code will use the workspace properties to determine if the workspace is an enterprise geodatabase or a database.
    Dim workspaceProperties As ESRI.ArcGIS.Geodatabase.IWorkspaceProperties=CType(workspace, ESRI.ArcGIS.Geodatabase.IWorkspaceProperties) 'Explicit Cast
    Dim isGDBProperty As ESRI.ArcGIS.Geodatabase.IWorkspaceProperty
    isGDBProperty=workspaceProperties.Property(ESRI.ArcGIS.Geodatabase.esriWorkspacePropertyGroupType.esriWorkspacePropertyGroup, _
                    ESRI.ArcGIS.Geodatabase.esriWorkspacePropertyType.esriWorkspacePropIsGeoDatabase)
    IsConnectedToGeodatabase=isGDBProperty.PropertyValue
End Function

• ESRI.ArcGIS.Geodatabase