Test the connection to the data store that is in the request body

post/admin/dataStores/connectionTest
Internal-Use Only

Attempts to connect to the data store that is specified in the request body. This endpoint requires the "svi.administration.core_metadata" capability.

Request Samples

1

Response Samples

1No example avaliable

Request Body

The data store object that is used to test the connection.

Information that is used for connecting to a database such as Oracle or SQL Server.

Example:
{"$ref":"#/components/examples/dataStoreExample"}
NameTypeRequiredDescription
id
integer
false

The primary key that uniquely identifies this metadata object.

createdBy
string
false

The user ID that created this metadata object.

createdAt
string<date-time>
false

The timestamp that indicates when this metadata object was created.

lastUpdatedBy
string
false

The user ID that most recently modified this metadata object.

lastUpdatedAt
string<date-time>
false

The timestamp that indicates when this metadata object was last modified.

name
string
false

The name of the data store.

type
string
false

The type of the data store.

Allowed value:
RELATIONAL
defaultSchemaName
string
false

The default schema name to be used for the data store.

version
integer
false

The internal version number for this data store.

connectionType
string
false

The type of database the system.

Allowed values:
internal_postgrespostgresdb2MySQLoracleSQL Serverteradata
host
string
false

The host name for the database server.

port
string
false

The TCP/IP port number for connecting to the database server.

username
string
false

The user name for connecting to the database server.

password
string
false

The password for connecting to the database server.

databaseNameOrServiceName
string
false

The name of the database to which to connect.

schema
string
false

The name of the target schema within the database.

initialSize
integer
false

The initial starting size for the database connection pool.

maxIdle
integer
false

The maximum number of idle connections that are allowed in the connection pool.

minIdle
integer
false

The minimum number of idle connections that are allowed in the connection pool.

maxActive
integer
false

The maximum number of active connections that are allowed in the connection pool.

handle
string
false

A string that is used to group key/value pairs that belong to a single data store (analogous to a folder). When creating a data store, this value must be unique. No other data store can have the same "handle" value. It is the responsibility of the client to determine a unique value.

urlAppendedParameters
string
false

Additional JDBC connection parameters that are appended to the end of the connection string.

advancedProperties
SAS Properties
false

Additional properties that are needed by other modules while interacting with this data store. For example, when loading data into CAS, etc.

assignedTimeZone
string
false

The default timezone for timestamp values that are stored in the database.

Responses

StatusMeaningDescription
204No ContentThe connection attempt was successful or connection testing has been disabled via the configuration settings.
400Bad RequestBad request. The possible causes are an invalid database type, an invalid database name, a missing host or port, or the inability to establish a socket connection. The error message and logs should clarify the issue. Schema