Source Custom Properties

Mis à jour : 5 décembre 2005

The data flow objects in the Microsoft SQL Server 2005 Integration Services object models have common properties and custom properties at the level of the component, input and output, and input column and output column. The custom properties can be accessed only at run time, and are not documented in the Integration Services Managed Programming Reference Documentation.

This topic lists and describes the custom properties of data flow sources.

• DataReader Source
• Excel Source
• Flat File Source
• OLE DB Source
• Raw File Source
• XML Source

For information about the properties common to most data flow objects, see Common Properties.

Some properties of sources can be set by using property expressions, as indicated in this topic. For more information, see Using Property Expressions to Specify Property Values for Data Flow Objects.

DataReader Source Custom Properties

The DataReader source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the DataReader source. All properties are read/write.

Property name	Data Type	Description
SqlCommand	String	The SQL statement that the DataReader source uses to extract data. The value of this property can be specified by using a property expression.

The output and the output columns of the DataReader source have no custom properties.

For more information, see Source DataReader.

Excel Source Custom Properties

The Excel source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the Excel source. All properties are read/write.

Property name	Data Type	Description
AccessMode	Integer	The mode used to access the database. The possible values are Open Rowset, Open Rowset from Variable, SQL Command, and SQL Command from Variable. The default value is Open Rowset.
CommandTimeout	Integer	The number of seconds before a command times out. A value of 0 indicates an infinite time-out. Note   This property is not available in the Excel Source Editor, but can be set by using the Advanced Editor.
OpenRowset	String	The name of the database object that is used to open a rowset.
OpenRowsetVariable	String	The variable that contains the name of the database object that is used to open a rowset.
ParameterMapping	String	The mapping from parameters in the SQL command to variables.
SqlCommand	String	The SQL command to be executed.
SqlCommandVariable	String	The variable that contains the SQL command to be executed.

The output and the output columns of the Excel source have no custom properties.

For more information, see Source Excel.

Flat File Source Custom Properties

The Flat File source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the Flat File source. All properties are read/write.

Property name

Data Type

Description

FileNameColumnName

String

The name of an output column that contains the file name. If no name is specified, no output column containing the file name will be generated.

Remarque :

This property is not available in the Flat File Source Editor, but can be set by using the Advanced Editor.

RetainNulls

Boolean

A value that specifies whether to retain Null values from the source file as Null values when the data is processed by the Data Transformation Pipeline engine. The default value of this property is False.

The output of the Flat File source has no custom properties.

The following table describes the custom properties of the output columns of the Flat File source. All properties are read/write.

Property name

Data Type

Description

FastParse

Boolean

A value that indicates whether the column uses the quicker, but locale-insensitive, fast parsing routines that DTS provides or the locale-sensitive standard parsing routines. For more information, see Analyse rapide and Analyse standard. The default value of this property is False.

Remarque :

This property is not available in the Flat File Source Editor, but can be set by using the Advanced Editor.

For more information, see Source de fichier plat.

OLE DB Source Custom Properties

The OLE DB source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the OLE DB source. All properties are read/write.

Property name

Data Type

Description

AccessMode

Integer

The mode used to access the database. The possible values are Open Rowset, Open Rowset from Variable, SQL Command, and SQL Command from Variable. The default value is Open Rowset.

AlwaysUseDefaultCodePage

Boolean

A value that indicates whether to use the value of the DefaultCodePage property for each column, or to try to derive the codepage from each column's locale. The default value of this property is False.

CommandTimeout

Integer

The number of seconds before a command times out. A value of 0 indicates an infinite time-out.

Remarque :

This property is not available in the OLE DB Source Editor, but can be set by using the Advanced Editor.

DefaultCodePage

Integer

The code page to use when code page information is unavailable from the data source.

OpenRowset

String

The name of the database object that is used to open a rowset.

OpenRowsetVariable

String

The variable that contains the name of the database object that is used to open a rowset.

ParameterMapping

String

The mapping from parameters in the SQL command to variables.

SqlCommand

String

The SQL command to be executed.

SqlCommandVariable

String

The variable that contains the SQL command to be executed.

The output and the output columns of the OLE DB source have no custom properties.

For more information, see Source OLE DB.

Raw File Source Custom Properties

The Raw File source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the Raw File source. All properties are read/write.

Property name	Data Type	Description
AccessMode	Integer (enumeration)	The mode used to access the raw data. The possible values are File name and File name from variable. The default value is File name.
FileName	String	The path and file name of the source file.

The output and the output columns of the Raw File source have no custom properties.

For more information, see Source de fichier brut.

XML Source Custom Properties

The XML source has both custom properties and the properties common to all data flow components.

The following table describes the custom properties of the XML source. All properties are read/write.

Property name	Data Type	Description
AccessMode	Integer	The mode used to access the XML data.
UseInlineSchema	Boolean	A value that indicates whether to use an inline schema definition within the XML source. The default value of this property is False.
XMLData	String	The file or variables from which to retrieve the XML data. The value of this property can be specified by using a property expression.
XMLSchemaDefinition	String	The path and file name of the schema definition file (.xsd). The value of this property can be specified by using a property expression.

The following table describes the custom properties of the output of the XML source. All properties are read/write.

Property name	Data Type	Description
RowsetID	String	A value that identifies the rowset associated with the output.

The output columns of the XML source have no custom properties.

For more information, see Source XML.

Change History

Release	History
5 décembre 2005	Changed content: Added available values for AccessMode property of multiple sources described in this topic.

Voir aussi

Référence

Common Properties
Transformation Custom Properties
Destination Custom Properties
Path Properties

Concepts

Using Property Expressions to Specify Property Values for Data Flow Objects

Autres ressources

Sources Integration Services

Aide et Informations

Assistance sur SQL Server 2005