Back to Top

Workspace properties

In this topic

  1. Summary
  2. Properties
  3. Code sample

Summary

The Describe function returns the properties described below for a workspace.

For a workspace, the Describe dataType property returns a value of "Workspace".

Properties

PropertyExplanationData Type
connectionProperties
(Read Only)

connectionProperties is a property set. The connection properties for an enterprise geodatabase workspace will vary depending on the type of enterprise database being used. Possible properties include the following:

  • authentication_mode—The credential authentication mode of the connection, either OSA or DBMS.
  • database—The database the workspace is connected to.
  • historical_name—The historical marker name of the historical version the workspace is connected to.
  • historical_timestamp—A date and time that represents a time stamp moment in the historical version the workspace is connected to.
  • is_geodatabase—Returns true if the database has been enabled to support a geodatabase; otherwise, it returns false. The is_geodatabase value is returned as a string.
  • instance—The instance the workspace is connected to.
  • server—The enterprise server name the workspace is connected to.
  • user—The connected user.
  • version—The transaction version name of the transactional version the workspace is connected to.
  • branch—The branch version name of the branch version the workspace is connected to.

Only one historical_name, historical_timestamp, version, or branch value exists for any given workspace.

Object
connectionString
(Read Only)

The connection string that is used in conjunction with the enterprise database type. For any other workspace type, an empty string is returned.

String
currentRelease
(Read Only)

For a geodatabase workspace, specifies whether the geodatabase's version is current. This property can be used to assess whether the geodatabase can be upgraded.

Boolean
domains
(Read Only)

A list containing the geodatabase domain names. To work with these domain names, you can use tools in the Domains toolset.

String
release
(Read Only)

For a geodatabase workspace, returns the geodatabase release value. The following table shows the mapping of geodatabase release values to ArcGIS version numbers:

Geodatabase release valueArcGIS version

2,2,0

9.2

2,3,0

9.3, 9.3.1

3,0,0

10.0–10.8.1

ArcGIS Pro 1.0–3.2

String
supportsBigInteger
(Read Only)

Specifies whether the workspace supports Big Integer type fields.

Boolean
supportsBigObjectID
(Read Only)

Specifies whether the workspace supports objects with 64-bit Object ID.

Boolean
supportsDateOnly
(Read Only)

Specifies whether the workspace supports fields of type Date Only.

Boolean
supportsTimeOnly
(Read Only)

Specifies whether the workspace supports fields of type Time Only.

Boolean
supportsTimestampOffset
(Read Only)

Specifies whether the workspace supports fields of type Timestamp Offset.

Boolean
workspaceFactoryProgID
(Read Only)

The ID is a string that you can use to distinguish between workspace types with a finer granularity than you can with workspaceType.

The following are workspaceFactoryProgID values returned for common workspace types:

  • esriDataSourcesGDB.AccessWorkspaceFactory.1—The ID indicates a personal geodatabase.
  • esriDataSourcesGDB.FileGDBWorkspaceFactory.1—The ID indicates a file geodatabase.
  • esriDataSourcesGDB.InMemoryWorkspaceFactory.1—The ID indicates an in-memory workspace.
  • esriDataSourcesGDB.MemoryWorkspaceFactory.1—The ID indicates a memory workspace.
  • esriDataSourcesGDB.SdeWorkspaceFactory.1—The ID indicates an enterprise geodatabase.
  • esriDataSourcesGDB.SqliteWorkspaceFactory.1—The ID indicates a mobile geodatabase.
  • (empty string)—An empty string indicates another workspace type.
Note:

Prior to ArcGIS Pro 3.0, a memory workspace would return a value of esriDataSourcesGDB.ColumnaDBWorkspaceFactory.1.

Tip:

The .1 following the string returned by workspaceFactoryProgID is only present in 64-bit products. If writing code that will be used with 32-bit and 64-bit products, use the startswith string method.

describe = arcpy.Describe(data)
# Not - if describe.workspaceFactoryProgID == 'esriDataSourcesGDB.FileGDBWorkspaceFactory.1'
if describe.workspaceFactoryProgID.startswith('esriDataSourcesGDB.FileGDBWorkspaceFactory'):
    continue
String
workspaceType
(Read Only)

Specifies the workspace type.

  • FileSystem—The workspace type is a file-based workspace (shapefile, coverage, and so on) or an in-memory workspace.
  • LocalDatabase—The workspace type is a local geodatabase (a file or personal geodatabase) or a memory workspace.
  • RemoteDatabase—The workspace type is a geodatabase that requires a remote connection (enterprise, OLE DB, and so on).
String

Code sample

Workspace properties example

The following stand-alone script displays some workspace properties for an enterprise database:

import arcpy

# Create a Describe object for an SDE database
#
desc = arcpy.Describe(r"C:data\Connection to state.sde")

# Print workspace properties
#
print("%-24s %s" % ("Connection String:", desc.connectionString))
print("%-24s %s" % ("WorkspaceFactoryProgID:", desc.workspaceFactoryProgID))
print("%-24s %s" % ("Workspace Type:", desc.workspaceType))

# Print Connection properties
#
cp = desc.connectionProperties
print("\nDatabase Connection Properties:")
print("%-12s %s" % ("  Server:", cp.server))
print("%-12s %s" % ("  Instance:", cp.instance))
print("%-12s %s" % ("  Database:", cp.database))
print("%-12s %s" % ("  User:", cp.user))
print("%-12s %s" % ("  Version:", cp.version))

# Print workspace domain names"
#
domains = desc.domains
print("\nDomains:")
for domain in domains:
    print("\t" + domain)

Feedback on this topic?

In this topic
  1. Summary
  2. Properties
  3. Code sample