StiODataConnector Class
Namespace: Stimulsoft.Base
Inheritance
Inherits from: StiRestDataConnector
Constructors
| Constructor | Description |
|---|---|
| StiODataConnector(string connectionString, NameValueCollection headers) |
StiODataConnector(connectionString: string, headers: NameValueCollection)
Parameters
- connectionString (string)
- headers (NameValueCollection)
Properties
| Property | Type | Description |
|---|---|---|
| AllowException | bool | |
| CookieContainer | CookieContainer | |
| Headers | NameValueCollection | List of headers used for http requests to load data. |
| Version | StiODataVersion | Get or sets value, which indicates Odata version. |
Methods
| Method | Returns | Description |
|---|---|---|
| FillDataTable | void | |
Get static |
StiODataConnector | |
| GetColumns | List<StiDataColumnSchema> | |
| GetSampleConnectionString | string | Returns sample of the connection string to this connector. |
| 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
FillDataTable
FillDataTable(table: DataTable, query: string): void
Parameters
- table (DataTable)
- query (string)
Get static
Get(connectionString: string, headers: NameValueCollection): StiODataConnector
Parameters
- connectionString (string)
- headers (NameValueCollection)
Returns StiODataConnector
GetColumns
GetColumns(collectionName: string): List<StiDataColumnSchema>
Parameters
- collectionName (string)
Returns List<StiDataColumnSchema>
GetSampleConnectionString
GetSampleConnectionString(): string
Returns sample of the connection string to this connector.
Returns string
RetrieveSchema
RetrieveSchema(allowException: bool): StiDataSchema
Returns schema object which contains information about structure of the database. Schema returned start at specified root element (if it applicable).
Parameters
- allowException (bool)
Returns StiDataSchema
TestConnection
TestConnection(): StiTestConnectionResult
Returns StiTestConnectionResult that is the information of whether the connection string specified in this class is correct.
Returns StiTestConnectionResult — The result of testing the connection string.