Skip to main content Skip to complementary content

IConnection Interface

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

Syntax

[ValueClass]
public interface IConnection

Properties

Name Description
ConnectionString

One of:

* ODBC CONNECT TO [<provider name>]

* OLEDB CONNECT TO [<provider name>]

* CUSTOM CONNECT TO [<provider name>]

* "<local absolute or relative path, UNC path>"

* "<URL>"

Connection string.

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

JSON property name: qConnectionString

Id

Identifier of the connection.

Is generated by the engine and is unique.

JSON property name: qId

LogOn

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

* LOG_ON_SERVICE_USER: Disables

* LOG_ON_CURRENT_USER: Enables

JSON property name: qLogOn

Meta

Information about the connection.

JSON property name: qMeta

ModifiedDate

Is generated by the engine.

Creation date of the connection or last modification date of the connection.

JSON property name: qModifiedDate

Name

Name of the connection.

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

JSON property name: qName

Password

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.

JSON property name: qPassword

Type

One of:

* ODBC

* OLEDB

* <Name of the custom connection file>

* 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.

JSON property name: qType

UserName

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.

JSON property name: qUserName

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!