**Deprecation notice**: Support for this database has been deprecated.
The adls-gen2 endpoint allows you to connect and manage Azure Data Lake Storage Gen2 data sources in Immuta.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
**Duplicate data sources**: In order to avoid two data sources referencing the same table, users can not create duplicate data sources. If you attempt to create a duplicate data source using the API, you will encounter a warning stating "duplicate tables are specified in the payload."
POST /adls-gen2/handler
Save the provided connection information as a data source.
| Attribute | Description | Required |
|---|---|---|
This request creates two Azure Data Lake Storage Gen2 data sources.
GET /adls-gen2/handler/{handlerId}
Get the handler metadata associated with the provided handler ID.
This request returns metadata for the handler with the ID 17.
PUT /adls-gen2/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.
This request updates the metadata for the data source with the handler ID 17.
The payload below updates the dataSourceName to Customer Details.
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
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 instance.
Yes
sqlTableName
string A string that represents this data source's table in the Query Engine.
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
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.
handlerId
integer The ID of the handler.
Yes
skipCache
boolean When true, will skip the handler cache when retrieving metadata.
No
body
array[object] Metadata about the data source, including the data source ID, schema, database, and connection string.
handlerId
integer The ID of the handler.
Yes
skipCache
boolean When true, will skip the handler cache when retrieving metadata.
No
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
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.