Update a data store by ID

put/admin/dataStores/{dataStoreId}
Internal-Use Only

Updates the data store with the specified ID to the data store definition that is contained in the request body. This endpoint requires the "svi.administration.core_metadata" capability.

Request Samples

1

Response Samples

1{
2 "id": 103000,
3 "createdBy": "videmo",
4 "createdAt": "2018-08-29T12:51:58.254Z",
5 "lastUpdatedBy": "videmo",
6 "lastUpdatedAt": "2018-08-29T12:51:58.254Z",
7 "name": "MyOracleDatabase",
8 "type": "RELATIONAL",
9 "defaultSchemaName": "MySchema",
10 "version": 0,
11 "connectionType": "oracle",
12 "host": "example.com",
13 "port": "15658",
14 "username": "MyUserName",
15 "reindexRequired": false,
16 "isCasDistributedDataLoadSupported": true,
17 "password": "*****",
18 "databaseNameOrServiceName": "MyOracleServiceName",
19 "schema": "MY_SCHEMA",
20 "initialSize": 1,
21 "handle": "MyOracleDatabasenRXFB",
22 "urlAppendedParameters": "FailoverPreconnect=false;JavaDoubleToString=false",
23 "advancedProperties": {
24 "ConnectionRetryCount": "5",
25 "ConnectionRetryDelay": "1",
26 "EnableBulkLoad": "1"
27 }
28}

Path Parameters

NameTypeRequiredDescription
dataStoreId
integer
true

The ID of the data store.

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The ETag of the representation in the request. If this header value is provided, it must match the ETag of the current version of the resource on the server. Otherwise, the server responds with a 412 error.

Request Body

The data store object to update the existing data store.

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
200OKThe request succeeded. The updated data store is returned.HeadersSchema
400Bad RequestThe request was invalid. The error message should clarify the issue. Possible reasons include: - The data store credentials are null in the request body's data store definition. - The data store handle is changed in the request body (this is not allowed). - The name is changed in the request body (this is not allowed). - A property is missing in the request body's data store definition. Schema
412Precondition FailedThe object in the request body was out of date.Schema