ConnectionSummary | Tableau Embedding API

Interface ConnectionSummary

Represents a connection within a datasource (ex: A SQL Server connection). A data source can be composed of one or more connections.

interface ConnectionSummary {
    id: string;
    name: string;
    serverURI: undefined | string;
    type: string;
}
Index

Properties

Properties

id: string

Unique string representing this connection.

name: string

The name of the connection (i.e. the caption).

serverURI: undefined | string

The URI to which the connection is pointing, if applicable. If a data source is a published data source, the URI is returned as localhost.

type: string

The type of the connection (i.e. SQL Server, web data connector).