OLE DB Custom Properties

 

Applies To: SQL Server 2016

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 nameData TypeDescription
AccessModeIntegerThe 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.
AlwaysUseDefaultCodePageBooleanA 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.
CommandTimeoutIntegerThe 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 OLE DB Source Editor, but can be set by using the Advanced Editor.
DefaultCodePageIntegerThe code page to use when code page information is unavailable from the data source.
OpenRowsetStringThe name of the database object that is used to open a rowset.
OpenRowsetVariableStringThe variable that contains the name of the database object that is used to open a rowset.
ParameterMappingStringThe mapping from parameters in the SQL command to variables.
SqlCommandStringThe SQL command to be executed.
SqlCommandVariableStringThe 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 OLE DB Source.

Destination Custom Properties

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

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

System_CAPS_ICON_note.jpg Note


The FastLoad options listed here (FastLoadKeepIdentity, FastLoadKeepNulls, and FastLoadOptions) correspond to the similarly named properties exposed by the IRowsetFastLoad interface implemented by the Microsoft OLE DB Provider for SQL Server (SQLOLEDB). For more information, search for IRowsetFastLoad in the MSDN Library.

Property nameData TypeDescription
AccessModeInteger (enumeration)A value that specifies how the destination access its destination database.

This property can have one of the following values:

 

 OpenRowset (0)—You provide the name of a table or view.

 OpenRowset from Variable (1)—You provide the name of a variable that contains the name of a table or view.

 OpenRowset Using Fastload (3)—You provide the name of a table or view.

 OpenRowset Using Fastload from Variable (4)—You provide the name of a variable that contains the name of a table or view.

 SQL Command (2)—You provide a SQL statement.
AlwaysUseDefaultCodePageBooleanA 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.
CommandTimeoutIntegerThe maximum number of seconds that the SQL command can run before timing out. A value of 0 indicates an infinite time. The default value of this property is 0.

Note: This property is not available in the OLE DB Destination Editor, but can be set by using the Advanced Editor.
DefaultCodePageIntegerThe default codepage associated with the OLE DB destination.
FastLoadKeepIdentityBooleanA value that specifies whether to copy identity values when data is loaded. This property is available only with one of the fast load options. The default value of this property is False. This property corresponds to the OLE DB IRowsetFastLoad (OLE DB) property SSPROP_FASTLOADKEEPIDENTITY.
FastLoadKeepNullsBooleanA value that specifies whether to copy Null values when data is loaded. This property is available only with one of the fast load options. The default value of this property is False. This property corresponds to the OLE DB IRowsetFastLoad (OLE DB) property SSPROP_FASTLOADKEEPNULLS.
FastLoadMaxInsertCommitSizeIntegerA value that specifies the batch size that the OLE DB destination tries to commit during fast load operations. The default value, 0, indicates a single commit operation after all rows are processed.
FastLoadOptionsStringA collection of fast load options. The fast load options include the locking of tables and the checking of constraints. You can specify one, both, or neither. This property corresponds to the OLE DB IRowsetFastLoad property SSPROP_FASTLOADOPTIONS and accepts string options such as CHECK_CONSTRAINTS and TABLOCK.

Note: Some options for this property are not available in the Excel Destination Editor, but can be set by using the Advanced Editor.
OpenRowsetStringWhen AccessMode is OpenRowset, the name of the table or view that the OLE DB destination accesses.
OpenRowsetVariableStringWhen AccessMode is OpenRowset from Variable, the name of the variable that contains the name of the table or view that the OLE DB destination accesses.
SqlCommandStringWhen AccessMode is SQL Command, the Transact-SQL statement that the OLE DB destination uses to specify the destination columns for the data.

The input and the input columns of the OLE DB destination have no custom properties.

For more information, see OLE DB Destination.

Common Properties

Community Additions

ADD
Show: