Type Alias ConnectionCreate

Schema used to create a connection with given connection string (qConnectStatement) along with other metadata

type ConnectionCreate = {
    datasourceID: string;
    ownerId?: string;
    qArchitecture?: 0 | 1;
    qConnectionSecret?: string;
    qConnectStatement: string;
    qCredentialsID?: string;
    qCredentialsName?: string;
    qEngineObjectID?: string;
    qID?: string;
    qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
    qName: string;
    qPassword?: string;
    qriInRequest?: string;
    qSeparateCredentials?: boolean;
    qType: string;
    qUsername?: string;
    space?: string;
    tags?: string[];
}
Index
datasourceID ownerId? qArchitecture? qConnectionSecret? qConnectStatement qCredentialsID? qCredentialsName? qEngineObjectID? qID? qLogOn? qName qPassword? qriInRequest? qSeparateCredentials? qType qUsername? space? tags?
datasourceID: string

ID of the datasource associated with this connection

ownerId?: string

App ID

qArchitecture?: 0 | 1

Indicates the data connector architecture. 0 for 64-bit, 1 for 32-bit. Default is 0, if not specified.

qConnectionSecret?: string

String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret

qConnectStatement: string

Connection string for the data connection

qCredentialsID?: string

ID of the credential associated with the connection

qCredentialsName?: string

Name of the credential associated with the connection

qEngineObjectID?: string

Unique identifier (UUID) for the data connection as specified by the Qlik Sense engine. A UUID will be generated automatically if this field is not specified or empty.

qID?: string

Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty.

qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER"

Logon type for the connection. LOG_ON_SERVICE_USER (or 0) indicates service user logon; LOG_ON_CURRENT_USER (or 1) indicates current user logon.

qName: string

Descriptive name of the data connection

qPassword?: string

Any logon password associated with the data connection (connector encoded)

qriInRequest?: string

The QRI (Qlik Resource Identifier) string for the connection. When provided by a trusted client, this value is persisted as the connection's QRI to ensure consistency.

qSeparateCredentials?: boolean

When true, creates a credential-less connection that does not embed authentication details. Default is false.

qType: string

The connection type, identifying the provider of the underlying connector.

qUsername?: string

Any logon username associated with the data connection

space?: string

ID of the space to which the connection belongs

tags?: string[]

List of tags attached to the connection. A maximum of 32 tags is allowed.

Settings
Member Visibility

On This Page
Properties