This page describes the presto
(Presto data sources) endpoint.
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
/presto/handler
Save the provided connection information as a data source.
This request creates a Presto data source.
GET
/presto/handler/{handlerId}
Get the handler metadata associated with the provided handler ID.
The following request returns the handler metadata associated with the provided handler ID.
PUT
/presto/handler/{handlerId}
Updates the handler 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 data source name to Marketing Data
for the data source with the handler ID 67
.
Request payload example
PUT
/presto/bulk
Updates the data source metadata associated with the provided connection string.
This request updates the metadata for all data sources with the connection string specified in example-payload.json
.
The payload below adds a certificate (certificate.json
) to the data sources with the provided connection.
PUT
/presto/handler/{handlerId}/triggerHighCardinalityJob
Recalculates the high cardinality column for the provided handler ID.
The response returns a string of characters that identify the high cardinality job run.
The following request recalculates the high cardinality column for the provided handler ID.
Attribute | Description | Required |
---|---|---|
Attribute | Description |
---|---|
Attribute | Description | Required |
---|---|---|
Attribute | Description |
---|---|
Endpoint | Purpose |
---|---|
Attribute | Description | Required |
---|---|---|
Attribute | Description |
---|---|
Attribute | Description | Required |
---|---|---|
Attribute | Description |
---|---|
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 instance.
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
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 specific handler ID.
Yes
skipCache
boolean
If true
the handler cache will be skipped when retrieving the handler data.
No
dataSourceId
integer
The data source ID.
value
metadata
Details regarding the handler.
handlerId
integer
The specific handler ID.
Yes
skipCache
boolean
If true
the handler cache will be skipped when retrieving the handler data.
No
dataSourceId
integer
The data source ID.
body
array[object]
Details regarding the handler, including schema, name format, and data source metadata.
body
array[object]
This payload includes data source metadata and specifies the connection string.
Yes
bulkId
integer
The bulk handler metadata ID.
connectionString
string
The specified connection string.
jobsCreated
integer
Number of jobs created.
handlerId
integer
The specific handler ID.
Yes
/presto/handler/{handlerId}
/presto/bulk
/presto/handler/{handlerId}/triggerHighCardinalityJob