Database Connection

Management of database connections.

List database connections

get

Returns a list of available database connections, which you can use to register Database assets.

This API only returns the connections that have already been synchronized with the catalog. If a specific database connection is missing, the /databaseConnections/refresh API can be called to refresh the database connections available in the catalog with the data source.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

edgeConnectionIdstring · uuidOptional

The ID of the Edge connection.

schemaConnectionIdstring · uuidOptional

The ID of the schema connection.

offsetinteger · int32Optional

The index of the first result to retrieve.

If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32 · max: 500Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 0) will be used. The maximum value for this parameter is 500.

Default: 0

Responses

200

Database connections successfully retrieved.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

get/databaseConnections

GET /rest/catalogDatabase/v1/databaseConnections HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "customer_db",
      "edgeConnectionId": "123e4567-e89b-12d3-a456-426614174000",
      "databaseId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Retrieve a database connection

get

Returns a specific database schema connection.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

databaseConnectionIdstring · uuidRequired

The ID of the database connection.

Responses

200

Represents a database connection.

application/json

The connection reference to the specific database.

idstring · uuidRequired

The ID of the database connection.

namestringRequired

The exact name of a database (catalog) read from the source.

Example: customer_db

edgeConnectionIdstring · uuidRequired

The ID of the Edge connection.

databaseIdstring · uuidOptional

The ID of the Database asset linked with this database connection.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

get/databaseConnections/{databaseConnectionId}

GET /rest/catalogDatabase/v1/databaseConnections/{databaseConnectionId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "customer_db",
  "edgeConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "databaseId": "123e4567-e89b-12d3-a456-426614174000"
}

Refresh database connections from the data source

post

Retrieve the database connections linked to a specific Edge connection and create the new database connections in Catalog.

This is an asynchronous API since it needs to reach out to the data source via Edge to retrieve the list of available database connections, which can take some time.

Authorizations

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

edgeConnectionIdstring · uuidRequired

The ID of the Edge connection.

Responses

202

The database connections synchronization job has started. The response includes the location of the GET API that you can use to monitor the job as a Location header.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

post/databaseConnections/refresh

POST /rest/catalogDatabase/v1/databaseConnections/refresh?edgeConnectionId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "resourceType": "View",
  "name": "Test name",
  "type": "IMPORT",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "progressPercentage": 50,
  "startDate": 1488016800,
  "endDate": 1488021800,
  "state": "COMPLETED",
  "message": "Import finished in 12s."
}