19 The XML Driver : Connection Option Descriptions

Connection Option Descriptions
The following connection option descriptions are listed alphabetically by the GUI name that appears on the driver Setup dialog. The connection string attribute name is listed immediately underneath the GUI name. For example:
Report Codepage Conversion Errors
Attribute
ReportCodepageConversionErrors
In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the alphabetical table of connection string attribute names.
Also, a few connection string attributes, for example, Password, do not have equivalent options that appear on the GUI. They are in the list of descriptions alphabetically by their attribute names.
NOTE: XML driver connection string attributes do not use short name equivalents.
Driver Setup Dialog Box Descriptions
Table 19-2 lists the connection string attributes associated with General, Advanced, and Options tabs of the XML driver Setup dialog box. The descriptions themselves are listed below the table.
Table 19-2. XML Attribute Names 
Data Source Name
Attribute
DataSourceName
Description
The name of a data source in your Windows Registry or odbc.ini file.
Valid Values
string
where string is the name of a data source.
Default
None
GUI Tab
General tab
Description
Attribute
Description
Description
An optional long description of a data source. This description is not used as a runtime connection attribute, but does appear in the ODBC.INI section of the Registry and in the odbc.ini file.
Valid Values
string
where string is a description of a data source.
Default
None
GUI Tab
General tab
Driver Options
Attribute
n/a
Description
Type configuration options specific to the XML driver.
Valid Values
WARNING: The properties you set in the Options tab override other properties for this session only and can adversely affect the operation of the XML driver. Use only authorized entries. For information about authorized entries for the Options tab, contact Progress DataDirect customer support.
Default
None
GUI Tab
Options tab
International Sort Order
Attribute
InternationalSort
Description
Uses international sort order as defined by your operating system when you issue a Select statement with an Order By clause.
Valid Values
0 | 1
If set to 1 (Enabled), this order is always alphabetic, regardless of case; the letters are sorted as "A, b, C." Refer to your operating system documentation concerning the sorting of accented characters.
If set to 0 (Disabled), ASCII sort order is used. This order sorts items alphabetically with uppercase letters preceding lowercase letters. For example, "A, b, C" is sorted as "A, C, b."
Default
0 (Disabled)
GUI Tab
Advanced tab
Location Names
Attribute
Location
Description
A display of all existing location names defined for the data source you are configuring.
Valid Values
string
where string is the name of a location.
The location names listed in the text box are used for connections according to the order that they are displayed. If you want to change the order or precedence, use the Up and Down buttons.
Default
None
GUI Tab
General tab
Logging
Attribute
Logging
Description
Creates a log file that logs the SQL execution plan. A value of 0 means no logging is performed.
Valid Values
0 | 1
If set to 1 (Enabled), a log file is created in the current directory. The default log file name is \Integrator.txt.
If set to 0 (Disabled), no logging is performed.
Default
0 (Disabled)
GUI Tab
Advanced tab
Read Only
Attribute
ReadOnly
Description
Controls whether the driver opens files for Read-Write access or Read-Only access
Valid Values
0 | 1
If set to 1 (Enabled), the driver opens XML files for Read-Only access. In this case, the XML driver opens XML files with a Shared Read lock. This allows other connections and applications to read the same XML file that the XML driver has open; however, they cannot write to the XML file.
If set to 0 (Disabled), the XML driver opens XML files for Read-Write access. Opening an XML file for Read-Write access places an exclusive lock on the file. No other connections or applications can open the XML file while the driver has the file open.
Default
0 (Disabled)
GUI Tab
Advanced tab
Report Codepage Conversion Errors
Attribute
ReportCodepageConversionErrors
Description
Specifies how the driver handles code page conversion errors that occur when a character cannot be converted from one character set to another.
An error message or warning can occur if an ODBC call causes a conversion error, or if an error occurs during code page conversions to and from the database or to and from the application. The error or warning generated is Code page conversion error encountered. In the case of parameter data conversion errors, the driver adds the following sentence: Error in parameter x, where x is the parameter number. The standard rules for returning specific row and column errors for bulk operations apply.
Valid Values
0 | 1 | 2
If set to 0 (Ignore Errors), the driver substitutes 0x1A for each character that cannot be converted and does not return a warning or error.
If set to 1 (Return Error), the driver returns an error instead of substituting 0x1A for unconverted characters.
If set to 2 (Return Warning), the driver substitutes 0x1A for each character that cannot be converted and returns a warning.
Default
0 (Ignore Errors)
GUI Tab
Advanced tab
Schema Mode
Attribute
n/a
Description
Specifies whether to show virtual schemas, manufactured schemas, or both.
Valid Values
Choose one of the following options:
Show Virtual Schemas Only. This option returns "XML" in the Schema Name column when a SQLTables or SQLColumns operation is performed when connected to a data source. See Show Virtual Schemas.
Show Manufactured Schemas Only. This option returns the manufactured schema names in the Schema Name column when a SQLTables or SQLColumns operation is performed when connected to a data source. See Show Manufactured Schemas.
Show Both Virtual and Manufactured Schemas. This option returns both virtual and manufactured schema names when a SQLTables or SQLColumns operation is performed when connected to a data source.
Default
Show Virtual Schemas Only
GUI Tab
Advanced tab
Show Manufactured Schemas
Attribute
ShowManufacturedSchemas
Description
Returns the manufactured schema names in the Schema Name column when a SQLTables or SQLColumns operation is performed when connected to a data source. The Location names you define for a data source are manufactured into a schema name by adding a # symbol after the Location names. For example:
Valid Values
0 | 1
If set to 1 (Enabled), manufactured schema names are returned.
If set to 0 (Disabled), manufactured schema names are not returned.
To return both manufactured and virtual schema names, set this option to 1 (Enabled) and the Show Virtual Schemas option to 1 (Enabled).
Default
0 (Disabled)
GUI Tab
Advanced tab
Show Virtual Schemas
Attribute
ShowVirtualSchemas
Description
Returns "XML" in the Schema Name column when a SQLTables or SQLColumns operation is performed when connected to a data source. For example:
Valid Values
0 | 1
If set to 1 (Enabled), virtual schema names are returned.
If set to 0 (Disabled), virtual schema names are not returned.
To return both virtual and manufactured schema names, set this option to 1 (Enabled) and the Show Manufactured Schemas option to 1 (Enabled).
Default
1 (Enabled)
GUI Tab
Advanced tab
Configure Location Dialog Box Descriptions
Table 19-3 lists the connection string attributes associated with General and Advanced tabs of the XML driver Configure Location dialog box. The descriptions themselves are listed below the table. See “Defining Locations” for an explanation of locations.
NOTE: XML driver connection string attributes do not use short name equivalents.
The names of all connection options in this section are preceded by location_name, where location_name represents the name of a specific location that you have defined, for example, LOC1. See the description of the Location Name option for details.
Delete Linked Schema
Attribute
location_name.Delete Schema
Description
Specifies whether an externally-linked schema file is deleted when a table is deleted. This option is valid only for Folder location types. The XML document for the table contains a link to this external schema file. By default, this check box is not selected.
Valid Values
0 | 1
If set to 1 (Enabled), the externally-linked schema file is deleted when the table is deleted. If multiple XML documents are linked to the same schema file, the schema file is not deleted when a table is deleted.
If set to 0 (Disabled), the externally-linked schema file is not deleted when the table is deleted.
Default
0 (Disabled)
GUI Tab
Configure Location Advanced tab
Flush Every Change
Attribute
location_name.Flush Every Change
Description
Writes the data document to disk after every insert, update, or delete operation. This option is valid only for Folder location types.
Valid Values
0 | 1
If set to 1 (Enabled), the driver writes the data document to disk after every change.
If set to 0 (Disabled), the driver does not write the data document to disk after every change. Disabling this option can improve performance.
Default
1 (Enabled)
GUI Tab
Configure Location Advanced tab
Location
Attribute
location_name.Initial Catalog
Description
The full path name to the location you are defining.
Valid Values
location_directory
where location_directory is the full path name of the directory in which the data files are stored. For example:
LOC1.Initial Catalog=C:\Documents\filesml
Default
None
GUI Tab
Configure Location General tab
Location Name
Attribute
location_name
Description
A unique name for the location you are defining, for example, LOC1.
Valid Values
location_name={DataDirect Closed XML ADO Provider}
where location_name is the unique name of the location you are defining. For example, if you choose the location name LOC1, then:
LOC1={DataDirect Closed XML ADO Provider}
Default
None
GUI Tab
Configure Location General tab
Location Type
Attribute
location_name.Catalog Type Hint
Description
Specifies the type of location you are defining for the connection.
Valid Values
Folder | XML Document | HTML Document
For example:
LOC1.Catalog Type Hint=XML Document
See “Defining Locations” for the definition of each type.
Default
Folder
GUI Tab
Configure Location General tab
Max Rows to Scan
Attribute
location_name.Scan Rows
Description
An integer that represents the maximum number of rows to scan when the XML driver is determining the data type of each column. This option is valid only for XML Document location types.
Valid Values
0 | x
where x is the number of rows to scan.
If set to x, the driver scans a maximum of x rows in the table. During the scan, the driver inspects each column value in the row of a table and adjusts the data type determination for each column based on the corresponding value. The more sample column values it encounters, the more accurate the determination.
If set to 0, the driver scans all rows in the table. Disabling this option can improve performance because limiting the number of rows can reduce the amount of time it takes to determine the column information on very large documents. Because less information is available, however, the determination of the data types can be incorrect.
Default
0
GUI Tab
Configure Location Advanced tab
Password
Attribute
location_name.Password
Description
The password used to establish a connection to the location specified by location_name. A password is required only if the location to which you are connecting is password-protected.
This option is not available unless the Require User ID/Password option is enabled.
Valid Values
pwd
where pwd is a valid password.
WARNING: The encrypted password is stored in the Windows Registry.
Default
None
GUI Tab
Configure Location Advanced tab
Require User ID/Password
Attribute
location_name.Require Passwd
Description
Specifies whether a User ID and password are required to establish a connection to the location you are defining.
Valid Values
0 | 1
If set to 1 (Enabled), a User ID and password are required to establish a connection to the location. You must enable this option if the location you are defining is password-protected; otherwise, the connection will fail. Enabling this option causes a Logon dialog box to appear when connecting with the driver.
If set to 0 (Disabled), no user ID and password are required to establish a connection to the location.
Default
0 (Disabled)
GUI Tab
Configure Location Advanced tab
Resolve External References
Attribute
location_name.Resolve External
Description
Determines whether external references such as DTDs, Schemas, Entities, and Notations are resolved for the XML documents contained within the location specified by location_name.
Valid Values
0 | 1
If set to 1 (Enabled), the documents are not processed if the XML parser cannot locate the external references.
If set to 0 (Disabled), the document is processed, even if the XML parser cannot locate the external references.
Default
0 (Disabled)
GUI Tab
Configure Location Advanced tab
Row Hint
Attribute
location_name.Row Hint
Description
A string that specifies an Extensible Stylesheet Language (XSL) pattern to identify the nodes that make up the rows in the rowset of a tabular-formatted XML document contained within the location specified by location_name. See “Using Hints for Tabular-Formatted XML Documents” for details.
This option is valid only for Folder and HTML Document location types.
Valid Values
row_hint
where row_hint is an XSL pattern.
Default
None
GUI Tab
Configure Location Advanced tab
Table Creation
Attribute
location_name.Create Type
Description
Determines the style of XML that is generated when a new table is created. This option is valid only for Folder location types.
Valid Values
IE5DataIsland | ADO25 | DataDirect
DataDirect Format (DataDirect): New tables are created with the DataDirect format. This format conforms to the W3C recommendation for XML schema, working draft April 07, 2000.
See “Common Tabular Formats for XML Documents” for a description of each of these formats.
Default
DataDirect
GUI Tab
Configure Location Advanced tab
Table Hint
Attribute
location_name.Table Hint
Description
A string that specifies an Extensible Stylesheet Language (XSL) pattern to identify the table or rowset nodes in a tabular-formatted XML document contained within the location specified by location_name. See “Using Hints for Tabular-Formatted XML Documents” for details.
This option is valid only for Folder and HTML Document location types.
Valid Values
table_hint
where table_hint is an XSL pattern.
Default
None
GUI Tab
Configure Location Advanced tab
User ID
Attribute
location_name.User ID
Description
The User ID (user name) used to establish a connection to the location specified by location_name. A password is required only if the location to which you are connecting is password-protected.
This option is not available unless the Require User ID/Password option is enabled.
Valid Values
userid
where userid is a valid user name.
Default
None
GUI Tab
Configure Location Advanced tab
Validate Schema
Attribute
location_name.Validate Schema
Description
Determines whether the XML documents contained within the location specified by location_name are validated against their schema.
Valid Values
0 | 1
If set to 1 (Enabled), the XML documents are validated against their schema. This allows a well-formed XML document to be processed, even if the document is not valid.
If set to 0 (Disabled), the XML documents are not validated against their schema.
Default
0 (Disabled)
GUI Tab
Configure Location Advanced tab