StiNoSqlDataConnector Class
Namespace: Stimulsoft.Base
Inheritance
Inherits from: StiDataConnector
Constructors
| Constructor | Description |
|---|---|
| StiNoSqlDataConnector(string connectionString) |
StiNoSqlDataConnector(connectionString: string)
Parameters
- connectionString (string)
Properties
| Property | Type | Description |
|---|---|---|
| ConnectionString | string | Gets connection string to the database. |
| FolderAssembly | string | |
| NameAssembly | string |
Methods
| Method | Returns | Description |
|---|---|---|
Get static |
StiNoSqlDataConnector | |
| GetColumns | List<StiDataColumnSchema> | |
| GetDataTable | DataTable | |
| 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
Get static
Get(ident: StiConnectionIdent, connectionString: string): StiNoSqlDataConnector
Parameters
- ident (StiConnectionIdent)
- connectionString (string)
Returns StiNoSqlDataConnector
GetColumns
GetColumns(collectionName: string): List<StiDataColumnSchema>
Parameters
- collectionName (string)
Returns List<StiDataColumnSchema>
GetDataTable
GetDataTable(collectionName: string, query: string, index: int?, count: int?): DataTable
Parameters
- collectionName (string)
- query (string)
- index (int?)
- count (int?)
Returns DataTable
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.