You can configure an embedded database and data mapping using a database configuration file in XML format. Some of these values you can set in the file are the same as those you can set using the
Config Options connection option (see
“Connection Option Descriptions”). Some database configuration values can be set only using a configuration file.
where databasename is the name of the database to be configured. For example, if your environment has a database named mydb or a database configuration file named mydb.config, when the driver establishes a connection, it performs the following tasks:
The Database element is the root element of the database configuration file. It does not define any configuration; it contains all of the elements that do define the database configuration. One and only one Database element must exist.
defaultSchema: The name of the schema to use for unqualified table and column identifiers. If defaultSchema is not specified, the schema specified in the first useSchema child element is used as the default schema. The default is defaultSchema=SFORCE.
The UseSchema element specifies a schema that is visible to the user of this element. A schema contains the mapping between the remote data model and the relational tables the driver exposes. Multiple schemas can be associated with a user. At least one UseSchema element must exist.
name [required]: The name of the schema to associate with the user. The schema name is a string with a maximum length of 128 characters. The defaults are name=SFORCE [remote] and name=PUBLIC [local].
The Schema element defines the schema that contains the mapping for a remote data source. The database configuration file must contain at least one schema definition and may contain multiple schema definitions. Each schema definition defines the type of the data source to which the schema maps, the information to connect to the remote database (except password), and the information needed to configure the remote data model to relational table mapping. At least one Schema element must exist.
name [required]: The name of the schema that defines the data model to relational mapping. This attribute can be any valid identifier name. The defaults are name=SFORCE for the remote data source and name=PUBLIC for the local database.
type [required]: The type of remote data source for which the schema defines mapping. This attribute must be type=Salesforce for the remote data source and type=local for the local database.
The ConfigOptions element is a string that specifies the configuration options used to define how the remote data source data model is mapped to relational tables. The ConfigOption string has the same keys, values, and syntax as the Config Options connection option (see
“Connection Option Descriptions”) except that the enclosing parentheses are not required (see example configuration file). The default is an empty string.
The SessionOptions element is a string of key value pairs that specifies the information needed to connect to the remote data source. SessionOptions includes the server name and remote user id, for example: