Type Alias ConnectionGet

Essential fields of a connection

type ConnectionGet = {
    connectionProperties?: unknown;
    created?: string;
    datasourceID?: string;
    links: Link;
    privileges: Privilege[];
    qArchitecture: 0 | 1;
    qConnectionSecret?: string;
    qConnectStatement: string;
    qCredentialsID?: string;
    qEngineObjectID: string;
    qID: string;
    qLogOn: 0 | 1;
    qName: string;
    qri?: string;
    qSeparateCredentials?: boolean;
    qType: string;
    space?: string;
    tags?: string[];
    tenant: string;
    updated?: string;
    user?: string;
}
Index

Properties

connectionProperties? created? datasourceID? links privileges qArchitecture qConnectionSecret? qConnectStatement qCredentialsID? qEngineObjectID qID qLogOn qName qri? qSeparateCredentials? qType space? tags? tenant updated? user?

Properties

connectionProperties?: unknown

List of connection parsed from connection string (only available when query parseConnection=true is set)

created?: string

Datetime when the connection was created

datasourceID?: string

Data source ID

links: Link
privileges: Privilege[]

Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection

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). This field will not be included in response of GET /data-connections, will only be included in the response of GET /data-connections/{qID}

qConnectStatement: string

Connection string for the data connection

qCredentialsID?: string

ID of the credential associated with the connection

qEngineObjectID: string

Unique identifier (UUID) for the data connection, must be same as qID

qID: string

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID

qLogOn: 0 | 1

Indicates the type of user associated with the data connection

qName: string

Descriptive name of the data connection

qri?: string

Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"')

qSeparateCredentials?: boolean

Indicates whether or not this is a credential-less connection

qType: string

Type of connection, i.e. provider type of underlying connector

space?: string

ID of the space to which the connection belongs

tags?: string[]

List of tags attached to the connection

tenant: string

Tenant ID of the connection's creator

updated?: string

Datetime when the connection was last updated

user?: string

User ID of the connection's creator

Settings

Member Visibility

On This Page

Properties