Type Alias ConnectionCreate

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

type ConnectionCreate = {
    datasourceID: string;
    owner?: 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

Properties

datasourceID owner? qArchitecture? qConnectionSecret? qConnectStatement qCredentialsID? qCredentialsName? qEngineObjectID? qID? qLogOn? qName qPassword? qriInRequest? qSeparateCredentials? qType qUsername? space? tags?

Properties

datasourceID: string

ID of the datasource associated with this connection

owner?: string

App ID

qArchitecture?: 0 | 1

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 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 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"

Indicates the type of user associated with the data connection.

qName: string

Descriptive name of the data connection

qPassword?: string

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

qriInRequest?: string

QRI string of the connection. The string will be persisted to mongo when the request is originated from trusted client (i.e. dcaas) to avoid invalid QRi string.

qSeparateCredentials?: boolean

Indicates whether or not to create a credential-less connection

qType: string

Type of connection - indicates connection provider type

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 (allow max 32 tags)

Settings

Member Visibility

On This Page

Properties