Class WorkspaceClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[Guid("FBF5715B-A05D-11D4-A64C-0008C711C8C1")]
[ClassInterface(ClassInterfaceType.None)]
public class WorkspaceClass : Workspace, IWorkspace, IWorkspaceEvents_Event, IWorkspace2, IDataset, IDatasetContainer, IWorkspaceEdit, IWorkspaceEditControl, IFeatureWorkspace, IFeatureWorkspaceManage, IFeatureWorkspaceSchemaEdit, IGeodatabaseRelease, ITransactions, ITransactionsOptions, IWorkspaceDomains3, IWorkspaceDomains2, IWorkspaceDomains, ISpatialCacheManager2, ISpatialCacheManager, IDatabaseCompact, ISQLSyntax, IWorkspaceConfiguration, IWorkspaceSpatialReferenceInfo, IWorkspaceExtensionManager, IDatabaseConnectionInfo, IRasterWorkspaceEx, IWorkspaceEvents2_Event
Inheritance
WorkspaceClass
Implements
IWorkspaceEvents_Event
IWorkspaceEvents2_Event
Inherited Members

Explicit Interface Implementations

AbortEditOperation()

Aborts an edit operation.

virtual void AbortEditOperation()

Remarks

Applications are responsible for calling the AbortEditOperation method to abort an edit operation if errors are detected within the methods executed for an edit operation.

AbortTransaction()

Aborts the current transaction.

virtual void AbortTransaction()

Remarks

An application is responsible for stopping only those transactions (using CommitTransaction or AbortTransaction) that were started by the application.

AddDataset(IDataset)

Adds a dataset to the dataset collection.

virtual void AddDataset(IDataset datasetToAdd)

Parameters

datasetToAdd IDataset

Remarks

When calling this method on feature datasets, both the XY and Z spatial reference systems of the dataset (if applicable) must match those of the feature dataset.

AddDomain(IDomain)

Adds the given domain to the workspace.

virtual int AddDomain(IDomain Domain)

Parameters

Domain IDomain

Returns

int

Remarks

The AddDomain method is used when adding a new domain to a workspace. An error will be returned if the domain name already exists on an existing domain within the workspace. AddDomain will return the identifier of the domain once it is added to the workspace.

An error will be raised if the domain name contains an invalid character when calling AddDomain. The list of invalid characters can be determined by using the ISQLSyntax::GetInvalidCharacters method, minus the slash (both / and \), hyphen (-), comma (,), and space characters.

If you are looking to assoicate an existing domain to a field (or subtype) see IClassSchemaEdit::AlterDomain (or ISubtypes::SetDomain).

[C#]

    public void AddDomain(IWorkspace workspace, string nameOfDomain)
    {
        //The function shows how to create a new range domain, then add it to the workspace.
        IWorkspaceDomains workspaceDomains = workspace as IWorkspaceDomains;
       
        //Create a new range domain
        IRangeDomain rangeDomain = new RangeDomainClass();
        rangeDomain.MaxValue = 2000;
        rangeDomain.MinValue = 500;







        IDomain domain = rangeDomain as IDomain;
        domain.Name = nameOfDomain;
        domain.FieldType = esriFieldType.esriFieldTypeDouble;
        domain.SplitPolicy = esriSplitPolicyType.esriSPTGeometryRatio;
        domain.MergePolicy = esriMergePolicyType.esriMPTSumValues;



        //Add the new domain to the workspace;
        workspaceDomains.AddDomain(domain);
    }

AlterClassExtensionCLSID(string, UID, IPropertySet)

Changes the class extension COM class associated with this database class.

virtual void AlterClassExtensionCLSID(string Name, UID ClassExtensionCLSID, IPropertySet classExtensionProperties)

Parameters

Name string
ClassExtensionCLSID UID
classExtensionProperties IPropertySet

AlterDomain(IDomain)

Alters an existing domain in the workspace.

virtual void AlterDomain(IDomain Domain)

Parameters

Domain IDomain

Remarks

The AlterDomain method allows the user to take an existing domain and modify it, and then call AlterDomain passing it as an argument. Alternatively, the user may create a new instance of a domain with the same name, owner, and field type as an existing domain. The existing domain would be replaced with the new domain. The identifier of the new domain will be modified to match that of the existing domain that is being altered.

The main use of AlterDomain is for modifying the range or coded values associated with the domain.  Please note that the renaming of a Domain is only permitted through the use of the IWorkspaceDomains3.AlterDomainWithName method.

AlterDomainWithName(IDomain, string)

Alters an existing domain in the workspace.

virtual void AlterDomainWithName(IDomain Domain, string oldDomainName)

Parameters

Domain IDomain
oldDomainName string

Remarks

The AlterDomainWithName method takes as input a Domain object whose Name property is set to the new name and the old domain name.  The old domain name is used to reference to the domain that will be renamed.  All references to the Domain will be updated to use the new name, it is not neccessary to account for this.

AlterInstanceCLSID(string, UID)

Changes the instance COM class associated with this database class.

virtual void AlterInstanceCLSID(string Name, UID InstanceCLSID)

Parameters

Name string
InstanceCLSID UID

AnalyzeIndex(string, string)

Analyze the index to generate DBMS statistics.

virtual void AnalyzeIndex(string TableName, string Index)

Parameters

TableName string
Index string

Remarks

The AnalyzeTable and AnalyzeIndex methods can be used to acquire DBMS statistics on tables and table indexes. Having up-to-date statistics on a table is key to efficient query performance on the table and a key requirement for efficient queries against versioned tables. Note that datasets that are based on tables support the IDatasetAnalyze method; to analyze all of the tables in a feature dataset, use the IDatasetAnalyze::Analyze method on the feature dataset.

AnalyzeTable(string, int)

Analyze the table to generate DBMS statistics.

virtual void AnalyzeTable(string TableName, int tableComponents)

Parameters

TableName string
tableComponents int

Remarks

The AnalyzeTable and AnalyzeIndex methods can be used to acquire DBMS statistics on tables and table indexes. Having up-to-date statistics on a table is key to efficient query performance on the table and a key requirement for efficient queries against versioned tables. Note that datasets that are based on tables support the IDatasetAnalyze method; to analyze all of the tables in a feature dataset, use the IDatasetAnalyze::Analyze method on the feature dataset.

The TableComponents arguement takes values from the enumeration esriTableComponents.  These values include esriAddsTable, esriBusinessTable, esriDeletesTable, esriFeatureTable, and esriRasterTable.  The values can also be combined together.  For example, to analyze the business, adds, and deletes table, you would specify (esriBusinessTable + esriAddsTable + esriDeletesTable)

AutoCommitInterval

The auto commit interval is the number of modification operations before a database commit is executed.

virtual int AutoCommitInterval { get; set; }

Returns

int

Remarks

Setting the AutoCommitInterval to 0 turns auto-commit off, and ensures that the transaction will not commit until the application calls CommitTransaction. The AutoCommitInterval is explicitly set to 0 when an edit session is started. The original value will be reset when the edit session is stopped.

By default the AutoCommitInterval is set to 1000 and it should be noted that user defined transactions will be commited after this threshold is breached.

BrowseName

The browse name of the dataset.

virtual string BrowseName { get; set; }

Returns

string

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

BugfixVersion

Geodatabase bugfix version level.

virtual int BugfixVersion { get; }

Returns

int

CacheExpansionFactor

The extent expansion factor for the spatial cache.

virtual double CacheExpansionFactor { get; }

Returns

double

Remarks

The CacheExpansionFilter returns the expansion factor specified after a call to FillCacheEx.

CacheExtent

The extent of the spatial cache.

virtual IEnvelope CacheExtent { get; }

Returns

IEnvelope

Remarks

The CacheExtent property returns the envelope that represents the current boundary of the cached area. An empty envelope is returned if the cache is empty (the cache is not active).

CacheIsFull

Indicates if the spatial cache is full.

virtual bool CacheIsFull { get; }

Returns

bool

Remarks

The CacheIsFull property returns true if the cache is full (the cache is active). The FillCache method is used to make the cache active and to set the boundary of the cache. Calling FillCache causes the workspace to fetch objects from the database and fill the cache. The time to fill the cache and the amount of memory consumed with the cache depends on the extent of the cache and the density and size of features in the feature classes being cached.

CanCompact()

True if this dataset can be compacted.

virtual bool CanCompact()

Returns

bool

CanCopy()

True if this dataset can be copied.

virtual bool CanCopy()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

  • CAD Drawings
  • Coverages
  • DBase Tables
  • Info Tables
  • Raster Datasets
  • SDC datasets
  • SDC Network Datasets
  • Shapefiles
  • Shapefile Network Datasets

CanDelete()

True if this dataset can be deleted.

virtual bool CanDelete()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanDelete(IName)

Checks if an object can be deleted.

virtual bool CanDelete(IName aName)

Parameters

aName IName

Returns

bool

CanDeleteDomain[string]

Indicates if the user can delete the domain.

virtual bool CanDeleteDomain[string DomainName] { get; }

Parameters

DomainName string

Returns

bool

Remarks

CanDeleteDomain property returns TRUE if this domain can be deleted or FALSE if it cannot.

CanDeleteDomain, is used in conjunction with the DeleteDomain method. If the user attempts to delete a domain from a workspace rather than handling errors that may result during DeleteDomain (that is, the domain is in use), the user may first test whether the domain can be deleted via this property.

CanRename()

True if this dataset can be renamed.

virtual bool CanRename()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanRename(IName)

Checks if an object can be renamed.

virtual bool CanRename(IName aName)

Parameters

aName IName

Returns

bool

CanUpgrade

Indicates if the geodatabase can be upgraded with this interface. If not, then another utility must be used to upgrade it.

virtual bool CanUpgrade { get; }

Returns

bool

Remarks

Returns True for personal and File geodatabases, and False for ArcSDE geodatabases.

Category

The category of the dataset.

virtual string Category { get; }

Returns

string

Remarks

IDataset::Category returns a description of the category of the dataset.  The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog.  The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

CommitTransaction()

Commits the current transaction.

virtual void CommitTransaction()

Remarks

An application is responsible for stopping only those transactions (using CommitTransaction or AbortTransaction) that were started by the application.

Compact()

Compacts the database.

virtual void Compact()

ConfigurationKeywords

The available configuration keywords.

virtual IEnumConfigurationKeyword ConfigurationKeywords { get; }

Returns

IEnumConfigurationKeyword

Remarks

Returns an enumeration of all the of the configuration keywords for an ArcSDE or File geodatabase workspace.

ConnectedDatabase

The name of the connected database. It may be different from the DATABASE property in the workspace's connection properties.

virtual string ConnectedDatabase { get; }

Returns

string

Remarks

If the underlying DBMS does not support multiple databases or is a Personal or File Geodatabase, the ConnectedDatabase property will return an empty string.

ConnectedUser

The name of the connected user. It may be different from the USER property in the workspace's connection properties.

virtual string ConnectedUser { get; }

Returns

string

Remarks

If used with a Personal or File Geodatabase, the ConnectedUser property will return an empty string.

ConnectionProperties

The connection properties of the workspace.

virtual IPropertySet ConnectionProperties { get; }

Returns

IPropertySet

Remarks

The ConnectionProperties property of a workspace returns the set of named connection properties for this workspace.

Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

CreateFeatureClass(string, IFields, UID, UID, esriFeatureType, string, string)

Creates a new standalone feature class under the workspace.

virtual IFeatureClass CreateFeatureClass(string Name, IFields Fields, UID CLSID, UID EXTCLSID, esriFeatureType FeatureType, string ShapeFieldName, string ConfigKeyword)

Parameters

Name string
Fields IFields
CLSID UID
EXTCLSID UID
FeatureType esriFeatureType
ShapeFieldName string
ConfigKeyword string

Returns

IFeatureClass

Remarks

The CreateFeatureClass method can be used to create a stand-alone feature class that is not part of a feature dataset. It takes, in addition to all the parameters that CreateTable takes, an esriFeatureType parameter that specifies the category of features to be stored in this feature class (i.e., esriFTSimple, esriFTComplexEdgeFeature) and a shape field name. The shape field name identifies the name of the field in the input fields collection that represents the shape field for the feature class.

The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.

The GeometryDef object associated with the shape field object must be fully setup with a spatial reference, grid properties, and the geometry type before calling CreateFeatureClass.

The following esriGeometryType enumeration values represent the valid geometry types for a new feature class' GeometryDef object: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryMultiPatch.

If the feature class is being created in geodatabase then the fields collection must contain, at a minimum, an Object ID field and a Shape field. The required fields can be obtained from the class description for the type of object you wish to create (see the RequiredFields property on IObjectClassDescription).

The CLSID parameter is used to specify what type of feature will be contained by the class. If a null value is passed in for the CLSID, the geodatabase will return Feature instances from the class. In most cases, this is the desired behavior. If the feature class is used to store custom features, the GUID of the custom feature should be provided. Alternatively, the IClassSchemaEdit interface can be used to change the feature class' CLSID following creation.

The EXTCLSID parameter is used to specify what class will be instantiated as the feature class extension. This object must at least support the IClassExtension interface. If a null value is passed in for the EXTCLSID parameter, the feature class will not have a class extension associated with it. Since class extensions are not required, this is often the desired behavior. If the feature class should have an associated extension, the GUID of the class extension should be provided. Alternatively, the IClassSchemaEdit interface can be used to associate a class extension following creation.

The configurationKeywordparameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in the case of an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, and the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfigurationinterface.

If the workspace the feature class will be created in is a pre-9.2 geodatabase, you must ensure the GeometryDef references a low precision spatial reference. 9.1 and earlier versions of the geodatabase only support low precision spatial references, while 9.2 geodatabases require high precision spatial references. Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the feature class. Use the IGeodatabaseRelease interface to determine the release of the geodatabase.

Developers should be aware that calling this method on a shapefile workspace when a shapefile of the same name already exists will cause the existing shapefile to be deleted. To prevent this, check for the existence of a shapefile prior to calling this method.

Note:Table or feature class names with the following prefixes are not supported:


 ~ "gdb_"
 ~ "sde_"
 ~ "delta_"


CreateFeatureDataset(string, ISpatialReference)

Creates a new feature dataset.

virtual IFeatureDataset CreateFeatureDataset(string Name, ISpatialReference SpatialReference)

Parameters

Name string
SpatialReference ISpatialReference

Returns

IFeatureDataset

Remarks

The CreateFeatureDataset method can be used to create a new FeatureDataset given its name and spatial reference. Methods supported by the returned feature dataset allow creation of feature classes in the feature dataset.

If the workspace the FeatureDataset will be created in is a pre-9.2 Geodatabase, you must ensure the spatial reference is a low precision spatial reference.  9.1 and earlier versions of the Geodatabase only support low precision spatial references, while 9.2 Geodatabases require high precision spatial references.  Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the FeatureDataset.  Use the IGeodatabaseRelease interface to determine the release of the geodatabase

CreateQueryDef()

Create a query definition object.

virtual IQueryDef CreateQueryDef()

Returns

IQueryDef

Remarks

The CreateQueryDef method can be used to create a new query definition object that can be evaluated by returning a cursor.

With personal geodatabases, QueryDefs do not return newly inserted rows, within an edit session when the QueryDef contains a Where Clause.  The edits must be saved and the QueryDef executed outside of the edit session or Search must be used to return the information.

CreateRasterCatalog(string, IFields, string, string, string)

Creates a new raster catalog.

virtual IRasterCatalog CreateRasterCatalog(string Name, IFields Fields, string ShapeFieldName, string RasterFieldName, string ConfigKeyword)

Parameters

Name string
Fields IFields
ShapeFieldName string
RasterFieldName string
ConfigKeyword string

Returns

IRasterCatalog

Remarks

The CreateRasterCatalog method creates a new empty raster catalog in a Personal, File or ArcSDE geodatabase. At releases prior to 9.2, When you create a raster catalog, you need to set the x/y domain on the GeometryDef properly to cover the extents of all the rasters you will be loading to the raster catalog. If the extent of a raster dataset is beyond the specified x/y domain of the GeometryDef, it will not be loaded. Since 9.2, the x/y domain is optimized according to the spatial reference of the geometry column, so you do not need to set it manually.

CreateRasterDataset(string, int, rstPixelType, IRasterStorageDef, string, IRasterDef, IGeometryDef)

Creates a new raster dataset.

virtual IRasterDataset CreateRasterDataset(string Name, int numBands, rstPixelType PixelType, IRasterStorageDef StorageDef, string ConfigKeyword, IRasterDef RasterDef, IGeometryDef GeometryDef)

Parameters

Name string
numBands int
PixelType rstPixelType
StorageDef IRasterStorageDef
ConfigKeyword string
RasterDef IRasterDef
GeometryDef IGeometryDef

Returns

IRasterDataset

CreateRelationshipClass(string, IObjectClass, IObjectClass, string, string, esriRelCardinality, esriRelNotification, bool, bool, IFields, string, string, string, string)

Creates a new relationship class.

virtual IRelationshipClass CreateRelationshipClass(string relClassName, IObjectClass OriginClass, IObjectClass DestinationClass, string ForwardLabel, string BackwardLabel, esriRelCardinality Cardinality, esriRelNotification Notification, bool IsComposite, bool IsAttributed, IFields relAttrFields, string OriginPrimaryKey, string destPrimaryKey, string OriginForeignKey, string destForeignKey)

Parameters

relClassName string
OriginClass IObjectClass
DestinationClass IObjectClass
ForwardLabel string
BackwardLabel string
Cardinality esriRelCardinality
Notification esriRelNotification
IsComposite bool
IsAttributed bool
relAttrFields IFields
OriginPrimaryKey string
destPrimaryKey string
OriginForeignKey string
destForeignKey string

Returns

IRelationshipClass

Remarks

The CreateRelationshipClass method can be used to create a new stand-alone relationship class that is not part of a feature dataset. The relationship class is implemented as a separate data table whose name is the name of the relationship class if the cardinality is many-to-many or if the relationship class is attributed. The relAttribFields parameter is optional, and a null value may be passed in for non-attributed relationship classes.

Many-to-many or attributed relationship classes require specification of all four key fields—the OriginPrimaryKey and the destPrimaryKey parameters are the primary key fields for the origin and destination object classes. The OriginForeignKey and destForeignKey parameters are the names of the corresponding foreign keys that will be created in the data table representing the relationship class. If the relationship class is one-to-one or one-to-many and not attributed, then the relationship class is implemented as a foreign key field in the destination object class (the OriginForeignKey) that references the primary key field in the origin object class (the OriginPrimaryKey). In this case, the OriginPrimaryKey, the OriginForeignKey, and the destPrimaryKey must be supplied.

The Fields object passed to the relAttrFields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.

CreateTable(string, IFields, UID, UID, string)

Creates a new table.

virtual ITable CreateTable(string Name, IFields Fields, UID CLSID, UID EXTCLSID, string ConfigKeyword)

Parameters

Name string
Fields IFields
CLSID UID
EXTCLSID UID
ConfigKeyword string

Returns

ITable

Remarks

The CreateTable method can be used to create a new table or object class in the workspace.

The optional CLSID and EXTCLSID parameters allow the calling application to specify the GUIDs for the objects that implement the instance and the class extension behavior for an object class. If no CLSID is passed in, then the resulting table is not registered in the geodatabase object class data dictionary (It will support the IObjectClass interface but will have an ObjectClassID of –1). Valid values for CLSID are esriGeoDatabase.Object or any non-spatial object that extends esriGeoDatabase.Object. CLSID must be set in order to apply a class extension with the EXTCLSID parameter.

The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.

The optional configurationKeyword parameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface.

Note: Table or feature class names with the following prefixes are not supported:

  • "gdb_"
  • "sde_"
  • "delta_"

 

CurrentRelease

Indicates if the geodatabase at the current release level.

virtual bool CurrentRelease { get; }

Returns

bool

DatasetNames[esriDatasetType]

The DatasetNames in the workspace.

virtual IEnumDatasetName DatasetNames[esriDatasetType DatasetType] { get; }

Parameters

DatasetType esriDatasetType

Returns

IEnumDatasetName

Remarks

The DatasetNames method returns an enumerator over the dataset names in the workspace for the specified dataset type. Name objects are lightweight versions of the geodatabase objects they refer to, while still providing access to some of the properties/methods available in the geodatabase object. From a name object, an instance of the geodatabase object specified by the name object can be created/returned, and vice versa.

See esriDatasetType for more information on dataset types.

Browsing applications should use the DatasetNames method to obtain name objects. These dataset name objects contain the essential properties of the corresponding dataset objects and are faster to retrieve. If the actual dataset specified by a name object is required (for example, because the user selected it), then it can easily be instantiated by calling the Open method on the name object.

Using a dataset type of esriDTAny will return all the datasets or dataset names in the workspace, across all dataset types. Note that these methods return only the top-level datasets in the workspace. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the DatasetNames property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes. To get the feature class names within a feature dataset, the application needs to get the FeatureClassNames property on the top-level feature dataset name returned by the workspace.

Datasets[esriDatasetType]

The datasets in the workspace.

virtual IEnumDataset Datasets[esriDatasetType DatasetType] { get; }

Parameters

DatasetType esriDatasetType

Returns

IEnumDataset

Remarks

The Datasets method returns an enumerator over the datasets in the workspace of the specified dataset type. Not to be confused with DatasetNames, Datasets will return a fully hydrated dataset object.

See esriDatasetType for more information on dataset types.

Using a dataset type of esriDTAny will return all the datasets or datasets in the workspace, across all dataset types. Note that only the top-level datasets in the workspace are returned by these methods. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the Datasets property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes.

Delete()

Deletes this dataset.

virtual void Delete()

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

DeleteByName(IDatasetName)

Deletes an object by it's name.

virtual void DeleteByName(IDatasetName aName)

Parameters

aName IDatasetName

Remarks

The DeleteByName method can be used to delete a dataset given its name object. It can be useful when cleaning up partially loaded datasets that cannot be instantiated because of incomplete information. It is made use of by ArcCatalog’s delete command. Note that IDataset::Delete is directly available as a method on instantiated datasets.

The DeleteByName method will fail when called on feature classes that participate in geometric networks or topologies. In these cases, the containing dataset, a Geometric Network or Topology, must be deleted first in order to demote the feature classes from non-simple to simple.

DeleteDomain(string)

Deletes the given domain from the workspace.

virtual void DeleteDomain(string DomainName)

Parameters

DomainName string

Remarks

This method will delete a domain from the workspace. For DeleteDomain to execute successfully, you must be connected to the workspace as the user who created the domain you are deleting, and the domain must not be in use by any object classes in the database. Use the CanDeleteDomain property to determine if a domain can be deleted. To unassociate a domain with a field, use the IClassSchemaEdit::AlterDomain method.

DeleteRasterCatalog(string)

Deletes a raster catalog.

virtual void DeleteRasterCatalog(string Name)

Parameters

Name string

DeleteRasterDataset(string)

Deletes a raster dataset.

virtual void DeleteRasterDataset(string Name)

Parameters

Name string

DisableUndoRedo()

Disables Undo and Redo of edit operations.

virtual void DisableUndoRedo()

DomainByName[string]

The domain with the given name from the workspace.

virtual IDomain DomainByName[string DomainName] { get; }

Parameters

DomainName string

Returns

IDomain

Remarks

This property returns an IDomain for the domain in the workspace with the name provided. The domain name is a String.

Domains

All the domains in the workspace.

virtual IEnumDomain Domains { get; }

Returns

IEnumDomain

Remarks

This property return an enumeration of all of the domains on a workspace as an IEnumDomain. You can loop through this enumeration to get each domain.

DomainsByFieldType[esriFieldType]

The domain with the given name from the workspace.

virtual IEnumDomain DomainsByFieldType[esriFieldType Type] { get; }

Parameters

Type esriFieldType

Returns

IEnumDomain

Remarks

This property returns an enumeration of all of the domains in a workspace for a particular field type as an IEnumDomain. You can loop through this enumeration to get each domain.

EmptyCache()

Empties the spatial cache.

virtual void EmptyCache()

Remarks

The EmptyCache method empties the cache and makes it inactive.

EnableUndoRedo()

Enables Undo and Redo of edit operations.

virtual void EnableUndoRedo()

ExecuteSQL(string)

Executes the specified SQL statement.

virtual void ExecuteSQL(string sqlStmt)

Parameters

sqlStmt string

Remarks

The ExecuteSQL method can be used to send an arbitrary SQL statement to the underlying database for execution. The statement can be any DDL (data definition language) or DML (data manipulation language) statement but can not return any result sets. The syntax for the SQL is as required by the underlying database. The workspace supports an optional ISQLSyntax interface that provides information to applications on aspects of the SQL Syntax for the underlying database.

To determine if a workspace supports the ExecutesSQL method, an application can check the value of the canExecuteSQLworkspace property via the optional IWorkspaceProperties interface. In general, this method is only supported on local and remote database workspaces.

Exists()

Checks if the workspace exists.

virtual bool Exists()

Returns

bool

Remarks

This method can be used with workspaces from file-based data sources to detect if they've been deleted by another application. For example, a shapefile workspace is a directory and can be deleted while the workspace is open.

Extension[int]

The workspace extension at this index.

virtual IWorkspaceExtension Extension[int Index] { get; }

Parameters

Index int

Returns

IWorkspaceExtension

ExtensionCount

The number of workspace extensions.

virtual int ExtensionCount { get; }

Returns

int

FillCache(IEnvelope)

Fills the spatial cache using the specified extent.

virtual void FillCache(IEnvelope Extent)

Parameters

Extent IEnvelope

Remarks

The CacheIsFull property returns true if the cache is full (the cache is active). The FillCache method is used to make the cache active and to set the boundary of the cache. Calling this method causes the workspace to fetch objects from the database and fill the cache. Only features in open feature classes within the cache extent are fetched. Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network.

The time to fill the cache and the amount of memory consumed with the cache depends on the extent of the cache and the density and size of features in the feature classes being cached.

It should be noted that all attributes of a feature within the envelope will be cached when the call is made to FillCache. Also, only those features that are in currently open feature classes will be cached. Therefore if you only want to perform spatial searches against a specific feature class it would make sense to only have that feature class open when the cache is filled. The more feature classes open when FillCache is called the more expensive the fill cache operation is.

FillCacheEx(IEnvelope, double)

Fills the spatial cache using the specified extent with an expansion factor.

virtual void FillCacheEx(IEnvelope Extent, double expansionFactor)

Parameters

Extent IEnvelope
expansionFactor double

Remarks

FillCacheEx takes an envelope and a parameter used to expand the envelope. The expand factor must be greater than 1 ; 1.1 would expand it by 10%, while 2 would double the size.

FindExtension(UID)

Finds the specified workspace extension by its globally unique id.

virtual IWorkspaceExtension FindExtension(UID GUID)

Parameters

GUID UID

Returns

IWorkspaceExtension

ForceCurrentRelease

Indicates if the geodatabase at the current release level.

virtual bool ForceCurrentRelease { get; }

Returns

bool

FullName

The associated name object.

virtual IName FullName { get; }

Returns

IName

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

GetDelimitedIdentifierCase()

True if DBMS's quoted identifiers are case sensitive.

virtual bool GetDelimitedIdentifierCase()

Returns

bool

GetFunctionName(esriSQLFunctionName)

DBMS dependent SQL function names.

virtual string GetFunctionName(esriSQLFunctionName sqlFunc)

Parameters

sqlFunc esriSQLFunctionName

Returns

string

GetIdentifierCase()

True if DBMS's identifiers are case sensitive.

virtual bool GetIdentifierCase()

Returns

bool

GetInvalidCharacters()

The list of invalid characters used in literals (if any).

virtual string GetInvalidCharacters()

Returns

string

GetInvalidStartingCharacters()

The list of invalid characters used in literals (if any).

virtual string GetInvalidStartingCharacters()

Returns

string

GetKeywords()

The list of DBMS specific reserved keywords.

virtual IEnumBSTR GetKeywords()

Returns

IEnumBSTR

GetSpecialCharacter(esriSQLSpecialCharacters)

Special DBMS dependent SQL characters.

virtual string GetSpecialCharacter(esriSQLSpecialCharacters sqlSC)

Parameters

sqlSC esriSQLSpecialCharacters

Returns

string

Remarks

The GetSpecialCharacter can be used to return the DBMS dependent character that represents an SQL special character, including the following:

• esriSQL_WildcardManyMatch ( % in SQL_92, * in Jet 4.0)
• esriSQL_WildcardSingleMatch ( _ in SQL_92, ? in Jet 4.0)
• esriSQL_DelimitedIdentifierPrefix ( " in SQL_92, [ in Jet 4.0)
• esriSQL_DelimitedIdentifierSuffix (" in SQL_92, ] in Jet 4.0)


GetStringComparisonCase()

True if string comparisons are case sensitive.

virtual bool GetStringComparisonCase()

Returns

bool

GetSupportedClauses()

Supported SQL clauses.

virtual int GetSupportedClauses()

Returns

int

GetSupportedPredicates()

Supported SQL predicates.

virtual int GetSupportedPredicates()

Returns

int

HasEdits(ref bool)

True if there are any completed edit operations that need to be saved .

virtual void HasEdits(ref bool HasEdits)

Parameters

HasEdits bool

HasRedos(ref bool)

True if there are any completed undos that can be redone.

virtual void HasRedos(ref bool HasRedos)

Parameters

HasRedos bool

HasUndos(ref bool)

True if there are any completed edit operations that can be undone.

virtual void HasUndos(ref bool HasUndos)

Parameters

HasUndos bool

IDataset_Type

The type of the Dataset.

virtual esriDatasetType IDataset_Type { get; }

Returns

esriDatasetType

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

ISpatialCacheManager2_CacheExtent

virtual IEnvelope ISpatialCacheManager2_CacheExtent { get; }

Returns

IEnvelope

ISpatialCacheManager2_CacheIsFull

virtual bool ISpatialCacheManager2_CacheIsFull { get; }

Returns

bool

ISpatialCacheManager2_EmptyCache()

virtual void ISpatialCacheManager2_EmptyCache()

ISpatialCacheManager2_FillCache(IEnvelope)

virtual void ISpatialCacheManager2_FillCache(IEnvelope Extent)

Parameters

Extent IEnvelope

IWorkspaceDomains2_AddDomain(IDomain)

virtual int IWorkspaceDomains2_AddDomain(IDomain Domain)

Parameters

Domain IDomain

Returns

int

IWorkspaceDomains2_CanDeleteDomain[string]

virtual bool IWorkspaceDomains2_CanDeleteDomain[string DomainName] { get; }

Parameters

DomainName string

Returns

bool

IWorkspaceDomains2_DeleteDomain(string)

virtual void IWorkspaceDomains2_DeleteDomain(string DomainName)

Parameters

DomainName string

IWorkspaceDomains2_DomainByName[string]

virtual IDomain IWorkspaceDomains2_DomainByName[string DomainName] { get; }

Parameters

DomainName string

Returns

IDomain

IWorkspaceDomains2_Domains

virtual IEnumDomain IWorkspaceDomains2_Domains { get; }

Returns

IEnumDomain

IWorkspaceDomains2_DomainsByFieldType[esriFieldType]

virtual IEnumDomain IWorkspaceDomains2_DomainsByFieldType[esriFieldType Type] { get; }

Parameters

Type esriFieldType

Returns

IEnumDomain

IWorkspaceDomains3_AddDomain(IDomain)

virtual int IWorkspaceDomains3_AddDomain(IDomain Domain)

Parameters

Domain IDomain

Returns

int

IWorkspaceDomains3_AlterDomain(IDomain)

virtual void IWorkspaceDomains3_AlterDomain(IDomain Domain)

Parameters

Domain IDomain

IWorkspaceDomains3_CanDeleteDomain[string]

virtual bool IWorkspaceDomains3_CanDeleteDomain[string DomainName] { get; }

Parameters

DomainName string

Returns

bool

IWorkspaceDomains3_DeleteDomain(string)

virtual void IWorkspaceDomains3_DeleteDomain(string DomainName)

Parameters

DomainName string

IWorkspaceDomains3_DomainByName[string]

virtual IDomain IWorkspaceDomains3_DomainByName[string DomainName] { get; }

Parameters

DomainName string

Returns

IDomain

IWorkspaceDomains3_Domains

virtual IEnumDomain IWorkspaceDomains3_Domains { get; }

Returns

IEnumDomain

IWorkspaceDomains3_DomainsByFieldType[esriFieldType]

virtual IEnumDomain IWorkspaceDomains3_DomainsByFieldType[esriFieldType Type] { get; }

Parameters

Type esriFieldType

Returns

IEnumDomain

IWorkspaceEvents2_Event_OnCreateDataset

virtual event IWorkspaceEvents_OnCreateDatasetEventHandler_2 IWorkspaceEvents2_Event_OnCreateDataset

Returns

IWorkspaceEvents_OnCreateDatasetEventHandler_2

IWorkspaceEvents2_Event_OnDeleteDataset

virtual event IWorkspaceEvents_OnDeleteDatasetEventHandler_2 IWorkspaceEvents2_Event_OnDeleteDataset

Returns

IWorkspaceEvents_OnDeleteDatasetEventHandler_2

IWorkspaceEvents2_Event_OnRenameDataset

virtual event IWorkspaceEvents_OnRenameDatasetEventHandler_2 IWorkspaceEvents2_Event_OnRenameDataset

Returns

IWorkspaceEvents_OnRenameDatasetEventHandler_2

InTransaction

Indicates if there is already a transaction in progress.

virtual bool InTransaction { get; }

Returns

bool

Remarks

ITransactions does not support nested transactions. The InTransaction property should be used to test if the workspace is already within a transaction.

IsBeingEdited()

True if the workspace is being edited.

virtual bool IsBeingEdited()

Returns

bool

IsDirectory()

TRUE if the workspace is a file system directory.

virtual bool IsDirectory()

Returns

bool

IsRegisteredAsObjectClass(string)

Checks if an object is registered as an object class.

virtual bool IsRegisteredAsObjectClass(string Name)

Parameters

Name string

Returns

bool

Remarks

IsRegisteredAsObjectClass indicates if an object in the database is referenced in the Geodatabase system tables. A table created using SQL, or an SDE layer created using the ArcSDE administration commands, or other ArcSDE client software are examples of objects that are not registered with the Geodatabase. These tables will have an ObjectClassID of -1.

You can use the RegisterAsObjectClass method on IClassSchemaEdit to register an object with the Geodatabase.

IsRegisteredAsVersioned(IName)

Checks if an object is registered as versioned.

virtual bool IsRegisteredAsVersioned(IName aName)

Parameters

aName IName

Returns

bool

Remarks

IsRegisteredAsVersioned indicates if a particular object in the workspace is versioned. This property applies only to objects stored in an ArcSDE workspace. You can register and unregister objects as versioned using the RegisterAsVersioned method on IVersionedObject.

MajorVersion

Geodatabase major version level.

virtual int MajorVersion { get; }

Returns

int

MinorVersion

Geodatabase minor version level.

virtual int MinorVersion { get; }

Returns

int

Name

The name of the Dataset.

virtual string Name { get; }

Returns

string

NameExists[esriDatasetType, string]

Indicates if a dataset with the given name exists within the workspace.

virtual bool NameExists[esriDatasetType Type, string Name] { get; }

Parameters

Type esriDatasetType
Name string

Returns

bool

Remarks

NameExists allows you to determine if a dataset of the specified type and the supplied name already exists within the Workspace.  When the name string parameter is not qualified, NameExists will return True if any objects of the specified dataset type exist in the Workspace with the current user as the owner.  When a fully qualified name parameter is specified, NameExists will return True if an object of the specified dataset corresponds to the qualified name (on ArcSDE geodatabases, a fully qualified name would be databasename.username.tablename). NameExists will also consider tables that are not registered with the geodatabase.

The specified type must be supplied, the esriDTAny value is not supported.

If you would like to find out if a specific feature class exists in a feature dataset, you shouldloop through the results of IFeatureClassContainer::ClassByName, as NameExists will always check the entire Workspace for the existence of the feature class.

OnCreateDataset

virtual event IWorkspaceEvents_OnCreateDatasetEventHandler OnCreateDataset

Returns

IWorkspaceEvents_OnCreateDatasetEventHandler

OnDeleteDataset

virtual event IWorkspaceEvents_OnDeleteDatasetEventHandler OnDeleteDataset

Returns

IWorkspaceEvents_OnDeleteDatasetEventHandler

OnModifyDataset

virtual event IWorkspaceEvents2_OnModifyDatasetEventHandler OnModifyDataset

Returns

IWorkspaceEvents2_OnModifyDatasetEventHandler

OnRenameDataset

virtual event IWorkspaceEvents_OnRenameDatasetEventHandler OnRenameDataset

Returns

IWorkspaceEvents_OnRenameDatasetEventHandler

OpenExtensionDataset(esriDatasetType, string)

Opens an existing extension dataset.

virtual IDataset OpenExtensionDataset(esriDatasetType extensionDatasetType, string extensionDatasetName)

Parameters

extensionDatasetType esriDatasetType
extensionDatasetName string

Returns

IDataset

OpenFeatureClass(string)

Opens an existing feature class.

virtual IFeatureClass OpenFeatureClass(string Name)

Parameters

Name string

Returns

IFeatureClass

Remarks

The OpenFeatureClass method can be used to open any existing feature class in the workspace given its fully qualified name. Note that every feature class in a geodatabase has a unique fully qualified name, and the OpenFeatureClass method can be used to directly open feature classes that are part of a feature dataset (the feature dataset name does not need to be specified).

Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable).  ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature class.  Use the NameExists method on the IWorkspace2 interface to determine if a feature class with the appropriate name exists in a geodatabase.

Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Some examples of how to use the Name parameter of OpenFeatureClass are shown below:

For Coverage feature classes:
buildings:polygon


For Oracle feature classes (the owner prefix is unnecessary if you are connected as the owner of the feature class):
gdb.Buildings
For SQLServer feature classes:
fdo_data.gdb.Buildings
For Informix feature classes:
bladetest2:gdb.Buildings
For VPF feature classes:
ks032193:veg:vgfarea (library:coverage:feature class)
The library name for VPF data is case sensitive and must appear as it is stored in the LAT (Library Attribute Table)
The 4 tables associated with a Topology; T_#_DirtyAreas, T_#_PolyErrors, T_#_LineErrors and T_#_PointErrors cannot be directly edited. For this reason they cannot be opened and will fail with a general Geodatabase error.

OpenFeatureDataset(string)

Opens an existing feature dataset.

virtual IFeatureDataset OpenFeatureDataset(string Name)

Parameters

Name string

Returns

IFeatureDataset

Remarks

The OpenFeatureDataset method can be used to open any existing feature dataset in the workspace given its fully qualified name.

Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable).  ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature dataset.

OpenFeatureQuery(string, IQueryDef)

Opens a feature dataset containing a single feature class defined by the specified Query.

virtual IFeatureDataset OpenFeatureQuery(string QueryName, IQueryDef QueryDef)

Parameters

QueryName string
QueryDef IQueryDef

Returns

IFeatureDataset

Remarks

The OpenFeatureQuery can be used to open a virtual feature class whose definition is based on a QueryDef created using the CreateQueryDef method. The QueryDef can involve multiple tables as long as one of them is a feature class; the resulting virtual feature class can be used to construct a feature layer that can be added to a map. The shape column is required as part of the SubFields parameter of the QueryDef.

OpenRasterCatalog(string)

Opens an existing raster catalog.

virtual IRasterCatalog OpenRasterCatalog(string Name)

Parameters

Name string

Returns

IRasterCatalog

OpenRasterDataset(string)

Opens an existing raster dataset.

virtual IRasterDataset OpenRasterDataset(string Name)

Parameters

Name string

Returns

IRasterDataset

Remarks

The OpenRasterDataset method opens a raster dataset in the geodatabase. It provides access to the RasterDataset geodatabase workspace.

OpenRelationshipClass(string)

Opens an existing relationship class.

virtual IRelationshipClass OpenRelationshipClass(string Name)

Parameters

Name string

Returns

IRelationshipClass

Remarks

The OpenRelationshipClass method can be used to open any existing relationship class in the workspace given its fully qualified name.

Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable).  ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a relationship class.

OpenRelationshipQuery(IRelationshipClass, bool, IQueryFilter, ISelectionSet, string, bool)

The table of a relationship join query.

virtual ITable OpenRelationshipQuery(IRelationshipClass relClass, bool joinForward, IQueryFilter SrcQueryFilter, ISelectionSet SrcSelectionSet, string TargetColumns, bool DoNotPushJoinToDB)

Parameters

relClass IRelationshipClass
joinForward bool
SrcQueryFilter IQueryFilter
SrcSelectionSet ISelectionSet
TargetColumns string
DoNotPushJoinToDB bool

Returns

ITable

OpenTable(string)

Opens an existing table.

virtual ITable OpenTable(string Name)

Parameters

Name string

Returns

ITable

Remarks

The OpenTable method can be used to open any existing table or object class in the workspace given its fully qualified name. The table object returned will always support the ITable interface. The returned table object will support additional interfaces depending on the type of table. For example, object classes will additionally support the IObjectClass interface.
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable).  ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a table.  Use the NameExists method on the IWorkspace2 interface to determine if a table with the appropriate name exists in a geodatabase.
Some examples of how to use the name parameter of OpenTable are shown below:

For Coverage feature classes:
cover:feature("stream:arc")


For info tables:
cover:feature("stream.aat")
For Oracle tables:
gdb.Owners
For SQLServer tables:
fdo_data.gdb.Owners
For Informix tables:
bladetest2:gdb.Owners
The 4 tables associated with a Topology; T_#_DirtyAreas, T_#_PolyErrors, T_#_LineErrors and T_#_PointErrors cannot be directly edited. For this reason they cannot be opened and will fail with a general Geodatabase error.

ParseColumnName(string, out string, out string, out string, out string)

Given a column name, determine its qualification parts.

virtual void ParseColumnName(string FullName, out string dbName, out string OwnerName, out string TableName, out string columnName)

Parameters

FullName string
dbName string
OwnerName string
TableName string
columnName string

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 workspace.

The FullName paramter can be returned from the IDataset::Name property for a dataset in a Geodatabase and the IDatasetName::Name property for a dataset name object. Both methods return the fully qualified name for the dataset (the name object for the dataset is itself obtained using the IDataset::FullName property).

Empty strings will be returned for arguments that do not apply to the underlying DBMS. For example, supplying a FullName parameter of "gdb.Greeley_Parcels_1.AREA" to an ArcSDE Geodatabase on Oracle will result in:

dbName = ""

ownerName = "gdb"

TableName = "Greeley_Parcels_1"

columnName = "AREA"

[C#]

    // e.g., fieldName = field.Name;
    //       fieldName = "sde.Greeley_Parcels_1.AREA"
    public void ISQLSyntax__ParseColumnName(IWorkspace workspace,string fieldName)
    {  
        string nameOfDatabase;
        string nameOfOwner;
        string nameOfTable;
        string nameOfColumn;






        ISQLSyntax sqlSyntax = (ISQLSyntax)workspace;
        sqlSyntax.ParseColumnName(fieldName, out nameOfDatabase, out nameOfOwner, out nameOfTable, out nameOfColumn);

        Console.WriteLine("The database name is {0}", nameOfDatabase);
        Console.WriteLine("The owner name is {0}", nameOfOwner);
        Console.WriteLine("The table name is {0}", nameOfTable);
        Console.WriteLine("The column name is {0}", nameOfColumn);
    }



ParseTableName(string, out string, out string, out string)

Given a table name, determine its qualification parts.

virtual void ParseTableName(string FullName, out string dbName, out string OwnerName, out string TableName)

Parameters

FullName string
dbName string
OwnerName string
TableName string

Remarks

Applications should use the ParseTableName method to split the fully qualified name of a table into its components (database, owner, table).  ParseTableName can also be used to return the components of any fully qualified name of a dataset such as feature classes, feature datasets, geometric networks and topologies.

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 QualifyTableName method to determine the qualified name of a dataset for a given workspace.

The FullName parameter refers to the fully qualified name of the dataset and is returned by the  IDataset::Name property for a dataset in a geodatabase and the IDatasetName::Name property for a dataset name object. Both methods return the fully qualified name for the dataset.

Empty strings will be returned for arguments that do not apply to the underlying DBMS. For example, supplying a FullName parameter of "MyTable" to a Personal or File Geodatabase will result in:

dbName = ""

ownerName = ""

TableName = "MyTable"

While supplying a FullName parameter of "gdb.MyTable" to an ArcSDE Geodatabase on Oracle will result in:

dbName = ""

ownerName = "gdb"

TableName = "MyTable"

[C#]


    public void ISQLSyntax__ParseTableName(IDataset dataset)
    {
        string nameOfDatabase;
        string nameOfOwner;
        string nameOfTable;
        string datasetName = dataset.Name;





        ISQLSyntax sqlSyntax = (ISQLSyntax)dataset.Workspace;
        sqlSyntax.ParseTableName(datasetName, out nameOfDatabase, out nameOfOwner, out nameOfTable);

        Console.WriteLine("The database name is {0}", nameOfDatabase);
        Console.WriteLine("The owner name is {0}", nameOfOwner);
        Console.WriteLine("The table name is {0}", nameOfTable);
    }


PathName

The file system full path of the workspace.

virtual string PathName { get; }

Returns

string

Remarks

If a remote workspace is opened using connection properties, this will be empty.

PropertySet

The set of properties for the dataset.

virtual IPropertySet PropertySet { get; }

Returns

IPropertySet

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

QualifyColumnName(string, string)

Given a table name and column name, returns its fully qualified name.

virtual string QualifyColumnName(string TableName, string columnName)

Parameters

TableName string
columnName string

Returns

string

Remarks

Applications should use the QualifyTableName and QualifyColumnName methods to construct fully qualified dataset and column names.

QualifyTableName(string, string, string)

Given a database, owner, and table name, return its fully qualified name.

virtual string QualifyTableName(string dbName, string OwnerName, string TableName)

Parameters

dbName string
OwnerName string
TableName string

Returns

string

Remarks

Applications should use the QualifyTableName and QualifyColumnName methods to construct fully qualified dataset and column names.

RedoEditOperation()

Causes a Redo to be performed on the last undo.

virtual void RedoEditOperation()

Remarks

The RedoEditOperation method rolls the state of the edit session forward to what it was after the execution of the edit operation at the top of the redo stack, pops the redone edit operation from the redo stack and pushes it back onto the undo stack. Performing a new edit operation clears the redo stack.

RegisterAsRasterCatalog(string, string, IGeometryDef)

Registers as a RasterCatalog.

virtual void RegisterAsRasterCatalog(string Name, string OIDFieldName, IGeometryDef GeometryDef)

Parameters

Name string
OIDFieldName string
GeometryDef IGeometryDef

Remarks

The RegisterAsRasterCatalog method provides a way to upgrade an 8.x embedded raster catalog to a 9.x raster catalog, because an 8.x raster catalog doesn’t have an OID or a GEOMETRY type column in its business table while a 9.x raster catalog does. This method will add these two columns to the raster catalog table and populate the Geometry column with the extent of each raster dataset in the raster catalog. This method works only with ArcSDE geodatabase.

RegisterAsRasterDataset(string, IGeometryDef)

Registers as a RasterDataset.

virtual void RegisterAsRasterDataset(string Name, IGeometryDef GeometryDef)

Parameters

Name string
GeometryDef IGeometryDef

Remarks

The RegisterAsRasterDataset method allows you to upgrade an 8.x raster dataset to a 9.x raster dataset in ArcSDE geodatabase, because an 8.x raster dataset doesn’t have a GEOMETRY column in its business table while a 9.x raster dataset does. This method only applies to ArcSDE geodatabase raster dataset. It is necessary to register an 8.x raster dataset to a 9.x raster dataset in order for the raster dataset to be recognized in any Geoprocessing tools.

RegisterExtension(string, UID)

Registers this workspace extension with the database making it required for successful connection to this database.

virtual void RegisterExtension(string Name, UID GUID)

Parameters

Name string
GUID UID

Rename(string)

Renames this Dataset.

virtual void Rename(string Name)

Parameters

Name string

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network.  In addition, certain feature classes, such as network feature classes, cannot be renamed.

SaveAsRasterDataset(string, IRaster, IRasterStorageDef, string, IRasterDef, IGeometryDef)

Creates a new raster dataset from another seed Raster.

virtual IRasterDataset SaveAsRasterDataset(string Name, IRaster Raster, IRasterStorageDef StorageDef, string ConfigKeyword, IRasterDef RasterDef, IGeometryDef GeometryDef)

Parameters

Name string
Raster IRaster
StorageDef IRasterStorageDef
ConfigKeyword string
RasterDef IRasterDef
GeometryDef IGeometryDef

Returns

IRasterDataset

Remarks

The SaveAsRasterDataset method provides a way to save any raster as a raster dataset in the geodatabase.  It is similar to the CreateRasterDataset method, but instead of creating an empty raster dataset, it copies the input raster properties and pixels to the output raster dataset in the geodatabase. If you want to keep the spatial reference of the input raster dataset for both raster column and geometry column, you can pass nothing to the RasterDef argument and GeometryDef argument.

 


 

SetStoreEventsRequired()

Indicates that insert and update cursors on simple classes cannot bypass store events

virtual void SetStoreEventsRequired()

Remarks

You must be editing features within a edit session for events to be fired.

SpatialReferenceInfo

The defined Spatial References in the Workspace.

virtual IEnumSpatialReferenceInfo SpatialReferenceInfo { get; }

Returns

IEnumSpatialReferenceInfo

StartEditOperation()

Begins an edit operation.

virtual void StartEditOperation()

Remarks

All related changes to objects in the database within an edit session should be grouped into edit operations. An edit operation is begun using the StartEditOperation method. An edit operation may be thought of as a short transaction nested within the long transaction corresponding to the edit session.

All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.

When using StartEditOperation, proper handling of errors, including the use of AbortEditOperation, is neccessary.

StartEditing(bool)

Starts editing the workspace.

virtual void StartEditing(bool withUndoRedo)

Parameters

withUndoRedo bool

Remarks

An edit session may be started using the StartEditing method. The withUndoRedo parameter can be used to suppress undo/redo logging if the workspace supports such suppression. Note that the supression of undo/redo logging is not supported for remote database workspaces.  StartEditing cannot be called when a edit session is already active.  StopEditing must be called first before a new edit session can be started.

Note:  With non-versioned editing always be sure to check the current edit state via IsBeingEdited before called StartEditing or StopEditing.  If the workspace is being edited outside your context, there is no need to call StartEditing.

StartTransaction()

Begins a new transaction.

virtual void StartTransaction()

Remarks

Applications are responsible for starting a new transaction (using the StartTransaction method) on the workspace only if the workspace is not already within a transaction. If the workspace is within an transaction this call will amount to a no operation without error. It should be noted that if CommitTransaction is then called it will be acting on the origin transaction and all changes within that original transaction wil be commited.

StopEditOperation()

Ends an edit operation.

virtual void StopEditOperation()

Remarks

Applications are responsible for calling StopEditOperation to mark the end of a successfully completed edit operation. Completed edit operations can be thought of as being pushed onto an undo stack.

All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.

When using StopEditOperation, proper handling of errors, including the use of AbortEditOperation, is necessary.

This method explicitly commit of any active transactions in the database.

StopEditing(bool)

Stops editing the workspace.

virtual void StopEditing(bool saveEdits)

Parameters

saveEdits bool

Remarks

The StopEditing method is used to end an edit session. The saveEdits parameter controls if edits are saved or discarded. An ArcSDE geodatabase can support multiple concurrent edit sessions on the same version of the database. In such a scenario, StopEditing will return an error code of FDO_E_VERSION_REDEFINED if it detects that the database state associated with the version being edited is no longer the same as it was at the beginning of the edit session (indicating that the version was modified by some other edit session). In this case the application is responsible for calling the IVersionEdit::Reconcile method to reconcile the edit session against the current state of the version being edited. StopEditing may be called again after reconciliation.

Note:  With non-versioned editing always be sure to check the current edit state via IsBeingEdited before called StartEditing or StopEditing.  If the workspace is being edited outside your context, there will be issues if you call StopEditing.  This will cause any other editors of the workspace to become decoupled with the potential loss of their edits.

This method explicitly commit of any active transactions in the database.

Subsets

Datasets contained within this dataset.

virtual IEnumDataset Subsets { get; }

Returns

IEnumDataset

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network.  To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Type

The Type of the Workspace.

virtual esriWorkspaceType Type { get; }

Returns

esriWorkspaceType

Remarks

See esriWorkspaceType for information on the types of workspaces.

UnRegisterExtension(UID)

UnRegisters this workspace extension making it no longer required for successful connection to this database.

virtual void UnRegisterExtension(UID GUID)

Parameters

GUID UID

UndoEditOperation()

Causes an Undo to be performed on the last edit operation.

virtual void UndoEditOperation()

Remarks

The UndoEditOperation can be used to roll the state of the edit session back to what it was prior to the execution of the edit operation at the top of the undo stack. Undoing an edit operation pops the edit operation from the Undo stack and adds it to a Redo stack.

Upgrade()

Upgrade the database to the current release level.

virtual void Upgrade()

Remarks

This method will upgrade the geodatabase system table release version to the current version of the ArcGIS software you are running. It will also augment the geodatabase system tables as required to complete the upgrade. An exclusive lock on the geodatabase is required to perform the upgrade. 

Upgrading a pre-ArcGIS 9.2 (low precision) geodatabase will not convert existing datasets within the geodatabase to high precision. In order to convert datasets from Low to High precision, use the IGeoDatasetSchemaEdit2::AlterResolution method.

Once the geodatabase has been upgraded, it is not usable in older versions of the software. Use the IGeodatabaseRelease2::DatasetSupported property to determine if the creation and use of particular datasets are supported within a geodatabase.

ValidateField(IField)

Validate a field, performing type conversion if necessary.

virtual IField ValidateField(IField inField)

Parameters

inField IField

Returns

IField

Remarks

The ValidateField method takes a Field definition as input, and based on its field type, scale and precision, returns a field definition that represents more closely how that field is actually stored in the database.

For example, a field whose type is esriFieldTypeSingle and its precision and scale are 0, then it will actually be stored in the database as a double.

Workspace

The workspace containing this dataset.

virtual IWorkspace Workspace { get; }

Returns

IWorkspace

Remarks

<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>

WorkspaceFactory

The factory that created the workspace.

virtual IWorkspaceFactory WorkspaceFactory { get; }

Returns

IWorkspaceFactory

Remarks

<CODE> <P>A WorkspaceFactory is a dispenser of workspaces and allows a client to connect to a workspace specified by a set of connection properties. A workspace represents a database or a datasource that contains one or more datasets. Examples of datasets include tables, feature classes and relationship classes. A WorkspaceFactory is a cocreatable, singleton object. A WorkspaceFactory maintains a pool of currently connected, active workspaces that are being referenced by the application. Connection properties are specified using a PropertySet object and can be saved to a connection file. A WorkspaceFactory also supports methods that can be used to browse and manage file system workspaces, and methods to manage connection files for remote database workspaces.</P></CODE>