Class SqlWorkspaceClass

Namespace
ESRI.ArcGIS.DatasourcesGDB
Assembly
ESRI.Server.DatasourcesGDB.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("1C062199-9253-4463-8E7A-E956F2998D65")]
public class SqlWorkspaceClass : SqlWorkspace, IDataset, IWorkspace, IWorkspaceProperties, ISQLSyntax, IDatabaseConnectionInfo2, IDatabaseConnectionInfo, ISqlWorkspace2, ISqlWorkspace, ISupportErrorInfo, IFeatureWorkspace, IWorkspaceConfiguration
Inheritance
SqlWorkspaceClass
Implements
Inherited Members

Explicit Interface Implementations

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.

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.

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.

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.

CheckDatasetName(string, IQueryDescription, out string)

virtual void CheckDatasetName(string Name, IQueryDescription QueryDescription, out string newName)

Parameters

Name string
QueryDescription IQueryDescription
newName string

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

virtual string ConnectedDatabase { get; }

Returns

string

ConnectedUser

virtual string ConnectedUser { get; }

Returns

string

ConnectionCurrentDateTime

The current DBMS date/time.

virtual object ConnectionCurrentDateTime { get; }

Returns

object

ConnectionDBMS

The type of DBMS this workspace is connected to.

virtual esriConnectionDBMS ConnectionDBMS { get; }

Returns

esriConnectionDBMS

Remarks

Returns an enumeration value corresponding to the connected DBMS. This might be particularly useful when implementing code that must access a number of different remote database types and depending on the underlying DBMS, change the code accordingly.

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.

ConnectionServer

The server this workspace is connected to.

virtual string ConnectionServer { get; }

Returns

string

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.

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_"

 

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.

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.

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.

GeodatabaseServerClass

The ArcSDE server class.

virtual esriGeodatabaseServerClassType GeodatabaseServerClass { get; }

Returns

esriGeodatabaseServerClassType

GetColumns(string, out IStringArray, out IStringArray, out IVariantArray, out ILongArray, out ILongArray, out ILongArray)

virtual void GetColumns(string TableName, out IStringArray columnName, out IStringArray columnType, out IVariantArray IsNullable, out ILongArray Size, out ILongArray Precision, out ILongArray Scale)

Parameters

TableName string
columnName IStringArray
columnType IStringArray
IsNullable IVariantArray
Size ILongArray
Precision ILongArray
Scale ILongArray

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

GetQueryDescription(string)

virtual IQueryDescription GetQueryDescription(string Query)

Parameters

Query string

Returns

IQueryDescription

GetQueryDescription2(string, bool)

Get query properties, optionally including spatial based on the first record of the query.

virtual IQueryDescription GetQueryDescription2(string Query, bool discoverSpatialProperties)

Parameters

Query string
discoverSpatialProperties bool

Returns

IQueryDescription

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

GetTables()

virtual IStringArray GetTables()

Returns

IStringArray

IWorkspace_Type

The Type of the Workspace.

virtual esriWorkspaceType IWorkspace_Type { get; }

Returns

esriWorkspaceType

Remarks

See esriWorkspaceType for information on the types of workspaces.

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsDirectory()

TRUE if the workspace is a file system directory.

virtual bool IsDirectory()

Returns

bool

Name

The name of the Dataset.

virtual string Name { get; }

Returns

string

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.

OpenQueryClass(string, IQueryDescription)

virtual ITable OpenQueryClass(string Name, IQueryDescription QueryDescription)

Parameters

Name string
QueryDescription IQueryDescription

Returns

ITable

OpenQueryCursor(string)

virtual ICursor OpenQueryCursor(string Query)

Parameters

Query string

Returns

ICursor

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.

Property[esriWorkspacePropertyGroupType, int]

Information about this particular property.

virtual IWorkspaceProperty Property[esriWorkspacePropertyGroupType propertyGroup, int PropertyType] { get; set; }

Parameters

propertyGroup esriWorkspacePropertyGroupType
PropertyType int

Returns

IWorkspaceProperty

Remarks

The IWorkspaceProperties::Property property has parameters for values from the esriWorkspacePropertyGroup enumeration and either the  esriWorkspacePropertyType enumeration or the esriWorkspaceTablePropertyType enumeration. It returns the value of the requested property as a WorkspaceProperty object.

The PropertySet parameter may require casting an esriWorkspacePropertyType or esriWorkspaceTablePropertyType value to an integer (or long). See the IWorkspaceProperties interface remarks for a discussion on this.

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.

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.

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

virtual esriDatasetType Type { get; }

Returns

esriDatasetType

Remarks

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

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>