# Create a Redshift Data Source

The `redshift` endpoint allows you to connect and manage Redshift data sources in Immuta.

{% hint style="info" %}
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
{% endhint %}

## Redshift workflow

1. [Create a data source](#create-a-data-source).
2. [Get information about a data source](#get-information-about-a-data-source).
3. [Manage data sources](#manage-data-sources).

## Create a data source

<mark style="color:green;">`POST`</mark> `/redshift/handler`

Save the provided connection information as a data source.

#### Payload parameters

| Attribute       | Description                                                                                                                    | Required |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------- |
| private         | `boolean` When `false`, the data source will be publicly available in the Immuta UI.                                           | **Yes**  |
| blobHandler     | `array[object]` A list of full URLs providing the locations of all blob store handlers to use with this data source.           | **Yes**  |
| blobHandlerType | `string` Describes the type of underlying blob handler that will be used with this data source (e.g., `MS SQL`).               | **Yes**  |
| recordFormat    | `string` The data format of blobs in the data source, such as `json`, `xml`, `html`, or `jpeg`.                                | **Yes**  |
| type            | `string` The type of data source: `ingested` (metadata will exist in Immuta) or `queryable` (metadata is dynamically queried). | **Yes**  |
| name            | `string` The name of the data source. It must be unique within the Immuta tenant.                                              | **Yes**  |
| sqlTableName    | `string` A string that represents this data source's table in Immuta.                                                          | **Yes**  |
| organization    | `string` The organization that owns the data source.                                                                           | **Yes**  |
| category        | `string` The category of the data source.                                                                                      | No       |
| description     | `string` The description of the data source.                                                                                   | No       |
| hasExamples     | `boolean` When `true`, the data source contains examples.                                                                      | No       |

#### Response parameters

| Attribute        | Description                                                                                                   |
| ---------------- | ------------------------------------------------------------------------------------------------------------- |
| id               | `integer` The handler ID.                                                                                     |
| dataSourceId     | `integer` The ID of the data source.                                                                          |
| warnings         | `string` This message describes issues with the created data source, such as the data source being unhealthy. |
| connectionString | `string` The connection string used to connect the data source to Immuta.                                     |

### Request example

This request creates two Redshift data sources, which are specified in `example-payload.json`.

```shell
curl \
    --request POST \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example-payload.json \
    https://demo.immuta.com/redshift/handler
```

#### Payload example

```json
{
  "handler": [{
    "metadata": {
      "ssl": true,
      "userFiles": [],
      "port": 5439,
      "hostname": "redshift.database.example.io",
      "database": "test",
      "username": "user",
      "password": "yourpassword",
      "schemaProjectName": "Army",
      "staleDataTolerance": 86400,
      "bodataSchemaName": "army",
      "bodataTableName": "army_records",
      "dataSourceName": "Army Army Records",
      "table": "army_records",
      "schema": "army",
      "nativeViewName": "army_records_immuta",
      "nativeSchemaName": "army_immuta",
      "nativeWorkspaceName": "immuta_test"
    }
  }, {
    "metadata": {
      "ssl": true,
      "userFiles": [],
      "port": 5439,
      "hostname": "redshift.database.example.io",
      "database": "test",
      "username": "user",
      "password": "your-password",
      "schemaProjectName": "Army",
      "staleDataTolerance": 86400,
      "bodataSchemaName": "army",
      "bodataTableName": "data",
      "dataSourceName": "Army Data",
      "table": "data",
      "schema": "army",
      "nativeViewName": "data_immuta",
      "nativeSchemaName": "army_immuta",
      "nativeWorkspaceName": "immuta_test"
    }
  }],
  "dataSource": {
    "blobHandler": {
      "scheme": "https",
      "url": ""
    },
    "blobHandlerType": "Redshift",
    "recordFormat": "",
    "type": "queryable",
    "schemaEvolutionId": null,
    "columnEvolutionEnabled": true
  },
  "schemaEvolution": {
    "ownerProfileId": 2,
    "config": {
      "nameTemplate": {
        "nameFormat": "<Schema> <Tablename>",
        "tableFormat": "<tablename>",
        "sqlSchemaNameFormat": "<schema>",
        "schemaProjectNameFormat": "<Schema>"
      }
    },
    "schemas": []
  }
}
```

### Response example

```json
{
  "connectionString":"user@redshift.database.example.io:5439/test"
}
```

## Get information about a data source

<mark style="color:green;">`GET`</mark> `/redshift/handler/{handlerId}`

Get the handler metadata associated with the provided handler ID.

#### Query parameters

| Attribute | Description                                                                  | Required |
| --------- | ---------------------------------------------------------------------------- | -------- |
| handlerId | `integer` The ID of the handler.                                             | **Yes**  |
| skipCache | `boolean` When `true`, will skip the handler cache when retrieving metadata. | No       |

#### Response parameters

| Attribute | Description                                                                                                            |
| --------- | ---------------------------------------------------------------------------------------------------------------------- |
| body      | `array[object]` Metadata about the data source, including the data source ID, schema, database, and connection string. |

### Request example

This request returns metadata for the handler with the ID `41`.

```shell
curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/redshift/handler/41
```

### Response Example

```json
{
  "dataSourceId": 41,
  "metadata": {
    "ssl": true,
    "port": 5439,
    "query": null,
    "table": "data",
    "schema": "army",
    "database": "test",
    "hostname": "redshift.database.example.io",
    "username": "user",
    "eventTime": "fileinfo.creationtime",
    "userFiles": [],
    "dataSourceName": "Army Data",
    "bodataTableName": "data",
    "bodataSchemaName": "army",
    "columnsNormalized": false,
    "schemaProjectName": "Army",
    "staleDataTolerance": 86400
  },
  "type": "odbcHandler",
  "connectionString": "user@redshift.database.example.io:5439/test",
  "id": 41,
  "createdAt": "2021-10-01T18:15:09.139Z",
  "updatedAt": "2021-10-01T18:15:09.274Z",
  "dbms": {
    "name": "redshift"
  }
}
```

## Manage data sources

| Method | Path                                                      | Purpose                                                                                                                                                                                                                                               |
| ------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| PUT    | `/redshift/handler/{handlerId}`                           | [Update the data source metadata associated with the provided handler ID](#update-a-specific-data-source). This endpoint does not perform partial updates, but will allow the dictionary to be omitted. In this case, it uses the current dictionary. |
| PUT    | `/redshift/bulk`                                          | [Update the data source metadata associated with the provided connection string](#update-multiple-data-sources).                                                                                                                                      |
| PUT    | `/redshift/handler/{handlerId}/triggerHighCardinalityJob` | [Recalculate the high cardinality column for the specified data source](#recalculate-the-high-cardinality-column-for-a-data-source).                                                                                                                  |
| PUT    | `/redshift/handler/{handlerId}/refreshNativeViewJob`      | [Refresh the view of a data source.](#refresh-a-view)                                                                                                                                                                                                 |

### Update a specific data source

<mark style="color:green;">`PUT`</mark> `/redshift/handler/{handlerId}`

Update the data source metadata associated with the provided handler ID. This endpoint does not perform partial updates, but will allow the dictionary to be omitted. In this case, it uses the current dictionary.

#### Query parameters

| Attribute | Description                                                                  | Required |
| --------- | ---------------------------------------------------------------------------- | -------- |
| handlerId | `integer` The ID of the handler.                                             | **Yes**  |
| skipCache | `boolean` When `true`, will skip the handler cache when retrieving metadata. | No       |

#### Payload parameters

| Attribute        | Description                                                                                                                | Required |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- |
| handler          | `metadata` Includes metadata about the handler, such as `ssl`, `port`, `database`, `hostname`, `username`, and `password`. | **Yes**  |
| connectionString | `string` The connection string used to connect to the data source.                                                         | **Yes**  |

#### Response parameters

| Attribute | Description                                                                                                                                                     |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id        | `integer` The ID of the handler.                                                                                                                                |
| ca        | `string` The certificate authority.                                                                                                                             |
| columns   | `array[object]` This is a Data Dictionary object, which provides metadata about the columns in the data source, including the name and data type of the column. |

#### Request example

This request updates the metadata for the data source with the handler ID `41`.

```shell
curl \
    --request PUT \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example-payload.json \
    https://demo.immuta.com/redshift/handler/41
```

**Payload example**

The payload below removes the `paragraph_count` column from the data source.

```json
{
  "handler": {
    "policyHandler": null,
    "dataSourceId": 41,
    "metadata": {
      "ssl": true,
      "port": 5439,
      "table": "data",
      "schema": "army",
      "database": "test",
      "hostname": "redshift.database.example.io",
      "username": "user",
      "eventTime": "fileinfo.creationtime",
      "userFiles": [],
      "dataSourceName": "Army Data",
      "bodataTableName": "data",
      "bodataSchemaName": "army",
      "columnsNormalized": false,
      "schemaProjectName": "Army",
      "staleDataTolerance": 86400,
      "columns": [{
        "name": "text",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "date",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "hashed_id",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "filename",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "storage_location",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "size",
        "dataType": "integer",
        "remoteType": "integer",
        "nullable": true
      }, {
        "name": "owner",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "dc:publisher",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:page-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "publisher",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "author",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "extended-properties:template",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "application-version",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "revision-number",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "page-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "last-author",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "character-count-with-spaces",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "xmptpg:npages",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "creation-date",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:last-author",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "extended-properties:application",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:creation-date",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:author",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "custom:contenttypeid",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "creator",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "x-parsed-by",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "content-type",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "modified",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "extended-properties:totaltime",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "application-name",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:character-count-with-spaces",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:save-date",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "line-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "template",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:character-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "last-save-date",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "last-modified",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "dcterms:modified",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:line-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "dcterms:created",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "word-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "extended-properties:company",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "dc:creator",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:word-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "meta:paragraph-count",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "extended-properties:appversion",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "total-time",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "cp:revision",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.group",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.isdirectory",
        "dataType": "boolean",
        "remoteType": "boolean",
        "nullable": true
      }, {
        "name": "fileinfo.isother",
        "dataType": "boolean",
        "remoteType": "boolean",
        "nullable": true
      }, {
        "name": "fileinfo.permissions",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.issymboliclink",
        "dataType": "boolean",
        "remoteType": "boolean",
        "nullable": true
      }, {
        "name": "fileinfo.size",
        "dataType": "integer",
        "remoteType": "integer",
        "nullable": true
      }, {
        "name": "fileinfo.file",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.filename",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.filekey",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "fileinfo.isregularfile",
        "dataType": "boolean",
        "remoteType": "boolean",
        "nullable": true
      }, {
        "name": "fileinfo.creationtime",
        "dataType": "timestamp",
        "remoteType": "timestamp",
        "nullable": true
      }, {
        "name": "fileinfo.lastmodifiedtime",
        "dataType": "timestamp",
        "remoteType": "timestamp",
        "nullable": true
      }, {
        "name": "fileinfo.lastaccesstime",
        "dataType": "timestamp",
        "remoteType": "timestamp",
        "nullable": true
      }, {
        "name": "fileinfo.owner",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "topsecretboolean",
        "dataType": "double precision",
        "remoteType": "double precision",
        "nullable": true
      }, {
        "name": "secretboolean",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "confidentialsecretboolean",
        "dataType": "double precision",
        "remoteType": "double precision",
        "nullable": true
      }, {
        "name": "classificationlevel",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "releasability",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }, {
        "name": "compartment",
        "dataType": "text",
        "remoteType": "string",
        "nullable": true
      }],
      "password": "yourpassword"
    },
    "type": "odbcHandler",
    "connectionString": "user@redshift.database.example.io:5439/test",
    "id": 41,
    "createdAt": "2021-10-01T18:15:09.139Z",
    "updatedAt": "2021-10-01T18:15:09.274Z",
    "dbms": {
      "name": "redshift"
    }
  }
}
```

#### Response example

```json
{
  "id": 41,
  "ca": ["-----BEGIN CERTIFICATE-----\ncertificatedata\n-----END CERTIFICATE-----"],
  "metadata": {
    "columns": [{
      "name": "text",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "date",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "hashed_id",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "filename",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "storage_location",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "size",
      "dataType": "integer",
      "remoteType": "integer",
      "nullable": true
    }, {
      "name": "owner",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "dc:publisher",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:page-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "publisher",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "author",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "extended-properties:template",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "application-version",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "revision-number",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "page-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "last-author",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "character-count-with-spaces",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "xmptpg:npages",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "creation-date",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:last-author",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "extended-properties:application",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:creation-date",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:author",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "custom:contenttypeid",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "creator",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "x-parsed-by",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "content-type",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "modified",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "extended-properties:totaltime",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "application-name",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:character-count-with-spaces",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:save-date",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "line-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "template",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:character-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "last-save-date",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "last-modified",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "dcterms:modified",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:line-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "dcterms:created",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "word-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "extended-properties:company",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "dc:creator",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:word-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "meta:paragraph-count",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "extended-properties:appversion",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "total-time",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "cp:revision",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.group",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.isdirectory",
      "dataType": "boolean",
      "remoteType": "boolean",
      "nullable": true
    }, {
      "name": "fileinfo.isother",
      "dataType": "boolean",
      "remoteType": "boolean",
      "nullable": true
    }, {
      "name": "fileinfo.permissions",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.issymboliclink",
      "dataType": "boolean",
      "remoteType": "boolean",
      "nullable": true
    }, {
      "name": "fileinfo.size",
      "dataType": "integer",
      "remoteType": "integer",
      "nullable": true
    }, {
      "name": "fileinfo.file",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.filename",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.filekey",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "fileinfo.isregularfile",
      "dataType": "boolean",
      "remoteType": "boolean",
      "nullable": true
    }, {
      "name": "fileinfo.creationtime",
      "dataType": "timestamp",
      "remoteType": "timestamp",
      "nullable": true
    }, {
      "name": "fileinfo.lastmodifiedtime",
      "dataType": "timestamp",
      "remoteType": "timestamp",
      "nullable": true
    }, {
      "name": "fileinfo.lastaccesstime",
      "dataType": "timestamp",
      "remoteType": "timestamp",
      "nullable": true
    }, {
      "name": "fileinfo.owner",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "topsecretboolean",
      "dataType": "double precision",
      "remoteType": "double precision",
      "nullable": true
    }, {
      "name": "secretboolean",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "confidentialsecretboolean",
      "dataType": "double precision",
      "remoteType": "double precision",
      "nullable": true
    }, {
      "name": "classificationlevel",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "releasability",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }, {
      "name": "compartment",
      "dataType": "text",
      "remoteType": "string",
      "nullable": true
    }]
  }
}
```

### Update multiple data sources

<mark style="color:green;">`PUT`</mark> `/redshift/bulk`

Update the data source metadata associated with the provided connection string.

#### Payload parameters

| Attribute        | Description                                                                                                                | Required |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- |
| handler          | `metadata` Includes metadata about the handler, such as `ssl`, `port`, `database`, `hostname`, `username`, and `password`. | **Yes**  |
| connectionString | `string` The connection string used to connect to the data sources.                                                        | **Yes**  |

#### Response parameters

| Attribute        | Description                                                                                                                      |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| bulkId           | `string` The ID of the bulk data source update.                                                                                  |
| connectionString | `string` The connection string shared by the data sources bulk updated.                                                          |
| jobsCreated      | `integer` The number of jobs that ran to update the data sources; this number corresponds to the number of data sources updated. |

#### Request example

This request updates the metadata for all data sources with the connection string specified in `example-payload.json`.

```shell
curl \
    --request PUT \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example-payload.json \
    https://demo.immuta.com/redshift/bulk
```

**Payload example**

The payload below adds a certificate (`certificate.json`) to connect to the data sources with the provided connection string.

```json
{
  "handler": {
    "metadata": {
      "ssl": true,
      "port": 5439,
      "database": "test",
      "hostname": "redshift.database.example.io",
      "username": "user",
      "userFiles": [{
        "keyName": "testcert",
        "filename": "bf349cbbfd3bc4eaf4ace7824a599fbc7cb5f7d5.json",
        "userFilename": "certificate.json"
      }],
      "password": "yourpassword"
    }
  },
  "connectionString": "user@sredshift.database.example.io:5000/test"
}
```

#### Response example

```json
{
  "bulkId": "bulk_ds_update_f50a8010dca03c07bcd0dc55eaf13c07",
  "connectionString": "yourusername@redshift.database.example.io:5000/tpc",
  "jobsCreated": 2
}
```

### Recalculate the high cardinality column for a data source

<mark style="color:green;">`PUT`</mark> `/redshift/handler/{handlerId}/triggerHighCardinalityJob`

Recalculate the high cardinality column for the specified data source.

#### Query parameters

| Attribute | Description                      | Required |
| --------- | -------------------------------- | -------- |
| handlerId | `integer` The ID of the handler. | **Yes**  |

#### Response parameters

The response returns a string of characters that identify the high cardinality job run.

#### Request example

This request re-runs the job that calculates the high cardinality column for the data source with the handler ID `41`.

```shell
curl \
    --request PUT \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/redshift/handler/41/triggerHighCardinalityJob
```

#### Response example

```json
0f5f08d0-22ee-11ec-b2b8-874838eeef05
```

### Refresh a view

<mark style="color:green;">`PUT`</mark> `/redshift/handler/{handlerId}/refreshNativeViewJob`

Refresh the view of a data source.

#### Query parameters

| Attribute | Description                      | Required |
| --------- | -------------------------------- | -------- |
| handlerId | `integer` The ID of the handler. | **Yes**  |

#### Response parameters

The response returns a string of characters that identifies the refresh view job run.

#### Request example

This request refreshes the view for the data source with the handler ID `7`.

```shell
curl \
    --request PUT \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://demo.immuta.com/redshift/handler/7/refreshNativeViewJob
```

#### Response example

```json
53c256d0-eb57-11ec-b275-d95a8e998142
```