StiFileDataConnector Class
Namespace: Stimulsoft.Base
Inheritance
Inherits from: StiDataConnector
Properties
| Property | Type | Description |
|---|---|---|
| FileType | StiFileType | A type of the file which can be processed with this connection helper. |
Methods
| Method | Returns | Description |
|---|---|---|
Get static |
StiFileDataConnector | |
| GetDataSet | DataSet | Returns DataSet based on specified options. |
| RetrieveSchema | StiDataSchema | Returns schema object which contains information about structure of the database. Schema returned start at specified root element (if it applicable). |
| TestConnection | StiTestConnectionResult | Returns StiTestConnectionResult that is the information of whether the connection string specified in this class is correct. |
Method Details
Get static
Get(ident: StiConnectionIdent): StiFileDataConnector
Parameters
- ident (StiConnectionIdent)
Returns StiFileDataConnector
GetDataSet
GetDataSet(options: StiFileDataOptions): DataSet
Returns DataSet based on specified options.
Parameters
- options (StiFileDataOptions)
Returns DataSet
RetrieveSchema
RetrieveSchema(options: StiFileDataOptions): StiDataSchema
Returns schema object which contains information about structure of the database. Schema returned start at specified root element (if it applicable).
Parameters
- options (StiFileDataOptions)
Returns StiDataSchema
TestConnection
TestConnection(options: StiFileDataOptions): StiTestConnectionResult
Returns StiTestConnectionResult that is the information of whether the connection string specified in this class is correct.
Parameters
- options (StiFileDataOptions)
Returns StiTestConnectionResult — The result of testing the connection string.