Connection API

Feature Data Objects API

 
Connection API
 
 
 

The following table shows the connection properties for each provider. “T” means true, and “F” means false. For important details, refer to the associated Notes.

DV=Default Value; R=Required; P=Protected; FN=FileName; FP=FilePath; D=Datastore; E=Enumerable
Provider/Properties DV R P FN FP D E Notes
OSGeo.ArcSDE.3.0                
   Server   T F F F F F 1
   Instance   T F F F F F 2
   Username   T F F F F F 3,4
   Password   T T F F F F 3,4
   Datastore   F F F F T T 5,6
OSGeo.MySQL.3.0               7
   Username   T F F F F F 8
   Password   T T F F F F 8
   Service   T F F F F F 9
   DataStore   F F F F T T 10
OSGeo.ODBC.3.0               11
   DataSourceName   F F F F F T 12
   UserId   F F F F F F 13
   Password   F T F F F F 13
   ConnectionString   F F F F F F 14
   GenerateDefaultGeometryProperty True F F F F F F  
OSGeo.SDF.3.0               15
   File   T F T F F F 16
   ReadOnly False F F F F F T 17
OSGeo.SHP.3.0                
   DefaultFileLocation   F F T F F F 18
   TemporaryFileLocation   F F T F F F 19
OSGeo.WFS.3.0                
   FeatureServer   T F F F F F 20
   Username   F F F F F F  
   Password   F F F F F F  
OSGeo.WMS.3.0               21
   FeatureServer   T F F F F F  
   Username   F F F F F F  
   Password   F F F F F F  
   DefaultImageHeight   F F F F F F  
Note
  1. The value of the Server property is the name or IP address of the host where the ArcSDE 9.1 Server instance runs.
  2. The value of the Instance property defines the port and protocol to use when communicating with the ArcSDE server. This instance name must be mapped to the TCP/IP listen port used by the Server to accept connection requests. This mapping is stored in the C:\WINDOWS\system32\drivers\etc\services file and has the form "instance_name portnum/protocol # comment". For example, "esri_sde_oracle 5151/tcp #ArcSDE Server listening port". There can be multiple instances because the server can connect to multiple back-end database technologies, for example, both Oracle and SQL Server.
  3. You must create the username and password from the sqlplus command-line when FDO Provider for ArcSDE is using Oracle as the back-end database technology. This is described in topic Create a Username and Password for the ArcSDE Provider Connected to Oracle.
  4. You must create the username and password from the Enterprise Manager when FDO Provider for ArcSDE is using SQL Server as the back-end database technology. This is described in topic Create a Username and Password for the ArcSDE Provider Connected to SQL Server.
  5. When FDO Provider for ArcSDE is using Oracle as the back-end database, the value of DataStore is always 'Default Datastore'.
  6. When FDO Provider for ArcSDE is using SQL Server as the back-end database, the value of DataStore is one of the values in the list of databases supported by that instance of the SQL Server.
  7. During the Windows installation of MySQL, be sure to specify a password for the root account.
  8. See User Management APIfor information about adding a username and password.
  9. The value of the Service property is localhost for a local connection and a valid domain name for a remote connection. A firewall at the remote end can prevent a connection from succeeding. However, note that the exception message will not tell you that this is the cause.
  10. The value of the DataStore property is one of the values enumerated in the connection property dictionary after opening a pending connection to the provider. This is described in topic Open a Pending Connection.
  11. You cannot use the ODBC provider either to create or destroy a feature schema. The provider will interpret numeric fields named X and Y to contain coordinate data; otherwise you must supply it with an xml file that tells it which column is X and which column is Y. With one qualification, you can use the provider to insert, update, and delete features in the data store; you cannot delete features in an Excel-based data store. See the topic Overview of the Connection Propertiesfor an overview of the use of ODBC connection properties.
  12. Use a Windows OS administrative tool to define a User or System DSN (data source name). FDO does not support the use of File DSN. This action associates a symbolic name with a resource that specifies how to access the data store, for example, a file path or RDBMS connection properties. Adding a User DSN for a Microsoft Access database file is described in the topic Create an ODBC DSN for an Excel File. Adding a User DSN for a Microsoft Excel file is described in the topic Create an ODBC DSN for an Excel File. Adding a User DSN for an Oracle database is described in the topic Create an ODBC DSN for an Oracle Database.
  13. Optional properties, depending on the data source.
  14. The connection string has the format DSN=myDSN;Uid=myUsername;Pwd=myPassword; or DSN=myDSN;Uid=;Pwd=; if there is no username or password.
  15. The SDF provider supports the .sdf file type.
  16. This is a file name. The named file is in the local file system.
  17. If True, only read operations on the file are permitted.
  18. The DefaultFileLocation can be either a directory in the file system or the name of an existing file.
  19. The TemporaryFileLocation is a folder where the SHP provider creates files that are normally co-located with the .shp file named in the DefaultFileLocation property, but are, for some reason, missing. These files have file types .shx, .sbn, .idx, .dbf, and .sbx.
  20. The value assigned to the FeatureServer property is a URL that identifies the location of a WFS server, for example, http://regis.intergraph.com/wfs/dcmetro/request.asp.
  21. The value assigned to the FeatureServer property is a URL that identifies the location of a WMS server, for example, http://wms.jpl.nasa.gov/wms.cgi. A WMS server may support more than one version of the OGC WMS specification. The FDO WMS provider allows users to connect to a WMS server that support the following WMS versions: 1.1.0, 1.1.1, and 1.3.0. By default, the FDO WMS provider will use version 1.3.0 when connecting to a WMS server. If a user wishes to change the default behavior and override the version that the provider uses to connect to the server, the value assigned to the FeatureServer connection property can be modified to include a version specifi-cation. This may be necessary if a server does not support a client connecting to the server using a version number of 1.3.0. The following are valid examples on how to explicitly specify the version number: http://terraservice.net/ogccapabilities.ashx?version=1.1.1, and http://www.bsc-eoc.org/cgi-bin/bsc_ows.asp?version=1.1.0. If version information is specified in such a manner, the WMS provider will honor the request and use the specified version.