StiCosmosDbConnector Class

Namespace: Stimulsoft.Base.Data.Connectors.Azure

Inheritance

Inherits from: StiDbNoSqlDataConnector

Constructors

Constructor Description
StiCosmosDbConnector(string connectionString, StiCosmosDbApi api)  

StiCosmosDbConnector(connectionString: string, api: StiCosmosDbApi)

Parameters

Properties

Property Type Description
Api StiCosmosDbApi  

Methods

Method Returns Description
ConvertDateTimeToJsonStr string  
Get static StiCosmosDbConnector  
GetColumns List<StiDataColumnSchema>  
GetDataTable DataTable  
GetSampleConnectionString string  
RetrieveSchema StiDataSchema  
TestConnection StiTestConnectionResult  

Method Details

ConvertDateTimeToJsonStr

ConvertDateTimeToJsonStr(date: DateTime): string

Parameters

  • date (DateTime)

Returns string


Get static

Get(connectionString: string): StiCosmosDbConnector

Parameters

  • connectionString (string)

Returns StiCosmosDbConnector


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 string


RetrieveSchema

RetrieveSchema(allowException: bool): StiDataSchema

Parameters

  • allowException (bool)

Returns StiDataSchema


TestConnection

TestConnection(): StiTestConnectionResult

Returns StiTestConnectionResult