FlatFileConnectionManager

Namespace: Chimayo.Ssis.Ast.ControlFlowApi

API to work with Flat File connection managers

Functions and values

Function or valueDescription
addColumn column
Signature: column:CfFlatFileColumn -> CfConnectionManager -> CfConnectionManager

Add a single column

addColumns columns
Signature: columns:CfFlatFileColumn list -> CfConnectionManager -> CfConnectionManager

Add multiple columns

addConnectionStringExpression expr
Signature: expr:string -> CfConnectionManager -> CfConnectionManager

Transform a file connection manager definition by adding a property expression for the connection string property

addExpression targetProperty expr
Signature: targetProperty:string -> expr:string -> CfConnectionManager -> CfConnectionManager

Transform a file connection manager definition by adding a property expression

clearColumns
Signature: CfConnectionManager -> CfConnectionManager

Clear all columns

create (...)
Signature: name:string -> fileUsageType:CfFileUsage -> rowFormat:CfFlatFileRowFormat -> connectionString:string -> CfConnectionManager

Create a new instance of a file connection manager definition

defineColumn (...)
Signature: name:string -> columnFormat:CfFlatFileColumnFormat -> encodeDelimiter:bool -> delimiter:string -> width:int -> maxWidth:int -> dataType:CfDataType -> precision:int -> scale:int -> isTextQualified:bool -> CfFlatFileColumn

Define a flat file column

encodeCharacter c
Signature: c:char -> string

Encode a single character for use in flat file connection manager configuration

encodeString s
Signature: s:string -> string

Encodes a string for use in flat file connection manager configuration

getCodePage
Signature: CfConnectionManager -> int option

Gets the code page, if any. Also used for UTF-7 and UTF-8

getColumnNamesInFirstDataRow
Signature: CfConnectionManager -> bool

Get the column names in first data row flag

getColumns
Signature: CfConnectionManager -> CfFlatFileColumn list

Get the columns

getConnectionString
Signature: CfConnectionManager -> string

Get the connection string

getDataRowsToSkip
Signature: CfConnectionManager -> int

Get the number of data rows to skip

getDelayValidation
Signature: CfConnectionManager -> bool

Get the delay validation flag

getFileUsageType
Signature: CfConnectionManager -> CfFileUsage

Get the file usage type

getHeaderRowDelimiter
Signature: CfConnectionManager -> string

Get the delimiter for header rows

getHeaderRowsToSkip
Signature: CfConnectionManager -> int

Get the number of header rows to skip

getLocaleId
Signature: CfConnectionManager -> int option

Get the locale id

getRowDelimiter
Signature: CfConnectionManager -> string

Get the row delimiter. For delimited files, this is encoded in the column delimiter

getRowFormat
Signature: CfConnectionManager -> CfFlatFileRowFormat

Get the row format

getTextQualifier
Signature: CfConnectionManager -> string

Get the text qualifier

isUnicode
Signature: CfConnectionManager -> bool

Gets the flag that indicates that Unicode processing is applied

setCodePage codePage
Signature: codePage:int -> CfConnectionManager -> CfConnectionManager

Set the connection manager to use the specified code page.

setColumnNamesInFirstDataRow enabled
Signature: enabled:bool -> CfConnectionManager -> CfConnectionManager

Set the column names in first data row flag

setConnectionString connectionString
Signature: connectionString:string -> CfConnectionManager -> CfConnectionManager

Set the connection string

setDataRowsToSkip rowsToSkip
Signature: rowsToSkip:int -> CfConnectionManager -> CfConnectionManager

Set the number of data rows to skip

setDelayValidation delayValidation
Signature: delayValidation:bool -> CfConnectionManager -> CfConnectionManager

Set the delay validation flag

setFileUsageType fileUsageType
Signature: fileUsageType:CfFileUsage -> CfConnectionManager -> CfConnectionManager

Set the file usage type

setHeaderRowDelimiter (...)
Signature: applyEncoding:bool -> delimiter:string -> CfConnectionManager -> CfConnectionManager

Set the delimiter for header rows

setHeaderRowsToSkip rowsToSkip
Signature: rowsToSkip:int -> CfConnectionManager -> CfConnectionManager

Set the number of header rows to skip

setLocaleId localeId
Signature: localeId:int option -> CfConnectionManager -> CfConnectionManager

Set the locale id

setRowDelimiter applyEncoding delimiter
Signature: applyEncoding:bool -> delimiter:string -> CfConnectionManager -> CfConnectionManager

Set the row delimiter. For delimited files, this is encoded in the column delimiter

setRowFormat rowFormat
Signature: rowFormat:CfFlatFileRowFormat -> CfConnectionManager -> CfConnectionManager

Set the row format

setTextQualifier (...)
Signature: applyEncoding:bool -> textQualifier:string -> CfConnectionManager -> CfConnectionManager

Set the text qualifier

setUnicode
Signature: CfConnectionManager -> CfConnectionManager

Set the connection manager to use Unicode (UCS-2) encoding

setUtf8
Signature: CfConnectionManager -> CfConnectionManager

Set the connection manager to use the UTF-8 encoding