API Connections Get v4

...

Property Description

connectParams.vendor The type of connection. See Connection Types.

connectParams.host Host of the source

connectParams.port Port number for the source

connectParams.jdbc JDBC type for the connection

connectParams.defaultDatabase (if applicable) Name of the default database

connectParams.extraLoadParams (if applicable) If the connection types supports them, this setting contains additional parameters to be passed to the host when making the connection.

id Internal identifier for the connection

host Host of the source

port Port number for the source

vendor String identifying the connection's vendor

params This setting is populated with any parameters that are passed to the source during connection and operations. For relational sources, this setting may include the default database and extra load parameters.

ssl

When true, the

D s platform

uses SSL to connect to the source.

vendorName Name of the vendor of the connection

name Internal name of the connection

description User-friendly description for the connection

type Type of connection

isGlobal

If true, the connection is public and available to all users.

Info
NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.

Default is false. A connection can be made public through the command line interface or the Connections page. See Connections Page.

credentialType The type of credentials used for the connection. This value varies depending on where the credentials are stored. See CLI for Connections.

credentialsShared If true, the credentials used for the connection are available for use by users who have been shared the connection.

uuid

A universal object identifier, which is unique across instances of the platform.

This internal identifier is particularly useful when create import mapping rules.

disableTypeInference

If set to false, type inferencing has been disabled for this connection. The default is true.

When type inferencing has been disabled, the

D s platform

does not apply

D s item

item	types

to data when it is imported. For more information, see Configure Type Inference.

createdAt Timestamp for when the connection was made

updatedAt Timestamp for when the connection was last updated

credentials

If present, these values are the credentials used to connect to the database.

Info

NOTE: For security reasons, you can store the connection's credentials in an external file on the

d-s-servernode

, after which they do not appear in this setting. See CLI for Connections.

creator.id Internal identifier of the user who created the connection.

updater.id Internal identifier of the user who last updated the connection.

workspace.id Internal identifier of the workspace with which this connection is associated.

...

Page tree

Versions Compared

Old Version 1

New Version Current

Key