Class StiNoSqlDataConnector

Hierarchy

Index

Properties

Methods

Properties

connectionIdent

connectionIdent: StiConnectionIdent

Gets a type of the connector.

connectionOrder

connectionOrder: StiConnectionOrder

Gets an order of the connector.

connectionString

connectionString: string

isAvailable

isAvailable: boolean

Get a value which indicates that this data connector can be used now.

name

name: string

The name of this connector.

nuGetPackages

nuGetPackages: string[]

Gets the package identificator for this connector.

nuGetVersion

nuGetVersion: string

Gets the package version for this connector.

Static advancedRetrievalModeOfDatabaseSchema

advancedRetrievalModeOfDatabaseSchema: boolean

If true then database information will be required from database with help of DataAdapter (instead Connection.GetSchema).

Static getSchemaColumnsMode

getSchemaColumnsMode: boolean = true

If true then in GetSchema method, column reference by index else by name.

Methods

getColumns

getDataTable

  • getDataTable(collectionName: string, query: string, index?: number, count?: number): DataTable

  • Parameters

    • collectionName: string
    • query: string
    • Default value index: number = null
    • Default value count: number = null

    Returns DataTable

getFamilyConnectors

getSampleConnectionString

  • getSampleConnectionString(): string

  • Returns sample of the connection string to this connector.

    Returns string

resetSettings

  • resetSettings(): void

retrieveSchema

  • Returns schema object which contains information about structure of the database. Schema returned start at specified root element (if it applicable).

    Parameters

    • Default value allowException: boolean = false

    Returns StiDataSchema

testConnection

  • Returns StiTestConnectionResult that is the information of whether the connection string specified in this class is correct.

    Returns StiTestConnectionResult

Generated using TypeDoc