StiMongoDbConnector Class

Namespace: Stimulsoft.Base

Inheritance

Inherits from: StiDbNoSqlDataConnector

Constructors

Constructor Description
StiMongoDbConnector(string connectionString)  

StiMongoDbConnector(connectionString: string)

Parameters

  • connectionString (string)

Methods

Method Returns Description
ConvertDateTimeToJsonStr string  
Get static StiMongoDbConnector  
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

ConvertDateTimeToJsonStr

ConvertDateTimeToJsonStr(date: DateTime): string

Parameters

  • date (DateTime)

Returns string


Get static

Get(connectionString: string): StiMongoDbConnector

Parameters

  • connectionString (string)

Returns StiMongoDbConnector


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.