Interface IConnection

interface IConnection {
    qConnectionString: string;
    qId: string;
    qLogOn: LogonType;
    qMeta: INxMeta;
    qModifiedDate: string;
    qName: string;
    qPassword?: string;
    qType: string;
    qUserName?: string;
}

Hierarchy

  • IConnection
    • IConnection

Properties

qConnectionString qId qLogOn qMeta qModifiedDate qName qPassword? qType qUserName?

Properties

qConnectionString

qConnectionString: string

One of:

  • ODBC CONNECT TO []
  • OLEDB CONNECT TO []
  • CUSTOM CONNECT TO []
  • "<local absolute or relative path,UNC path >"
  • ""

Connection string. This parameter is mandatory and must be set when creating or modifying a connection.

qId

qId: string

Identifier of the connection. Is generated by the engine and is unique.

qLogOn

qLogOn: LogonType

Select which user credentials to use to connect to the source.

  • LOG_ON_SERVICE_USER: Disables
  • LOG_ON_CURRENT_USER: Enables

qMeta

qMeta: INxMeta

Information about the connection.

qModifiedDate

qModifiedDate: string

Is generated by the engine. Creation date of the connection or last modification date of the connection.

qName

qName: string

Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.

Optional qPassword

qPassword?: string

Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection method does not return the password.

qType

qType: string

One of: - ODBC - OLEDB - - folder - internet

Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string.

The type is not case sensitive.

Optional qUserName

qUserName?: string

Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection method does not return the user name.

Settings

Member Visibility

Theme

On This Page