curl --request GET \
--url http://localhost:8080/api/v1/pipelines/{name}/unity-catalog \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/pipelines/{name}/unity-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/pipelines/{name}/unity-catalog")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipelines/{name}/unity-catalog")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pipeline": "<string>",
"enabled": true,
"enabledBy": "pipeline",
"syncSwitchedOff": true,
"coordinates": {
"catalog": "<string>",
"schema": "<string>",
"table": "<string>",
"qualified": "<string>",
"kind": "<string>",
"location": "<string>"
},
"state": "never",
"lastSyncAt": "<string>",
"lastRunId": "<string>",
"commentsHash": "<string>",
"tagsHash": "<string>",
"propertiesHash": "<string>",
"lastError": "<string>",
"lineageEnabled": true,
"lineage": "off",
"lineageHash": "<string>",
"lastLineageAt": "<string>",
"registerEnabled": true,
"register": "off",
"registeredMetadataLocation": "<string>",
"lastRegisterAt": "<string>",
"catalogMode": "register",
"restMetadataLocation": "<string>",
"lastRestCommitAt": "<string>",
"restRefusedReason": "<string>",
"restCreatedTable": "<string>"
}Unity Catalog sync state for a pipeline
Whether Unity Catalog sync is on for the pipeline (enabledBy: pipeline for its own block, default when DATRIS_UNITY_CATALOG_DEFAULT turned on a Databricks pipeline with no block, null when off with no block), its three-level table coordinates (Databricks destinations, or the registered table of an object-store Iceberg destination with unityCatalog.catalog set), the last sync (state is never, synced or error), the lineage publish status (lineage is off, never, published or error; lineage failures appear in lastError as lines prefixed uc-lineage:), and the Iceberg register status (register is off, never, registered, stale, error, rest, managed or refused; register warnings appear in lastError as lines prefixed uc-register:).
curl --request GET \
--url http://localhost:8080/api/v1/pipelines/{name}/unity-catalog \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/pipelines/{name}/unity-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/pipelines/{name}/unity-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/pipelines/{name}/unity-catalog")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/pipelines/{name}/unity-catalog")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pipeline": "<string>",
"enabled": true,
"enabledBy": "pipeline",
"syncSwitchedOff": true,
"coordinates": {
"catalog": "<string>",
"schema": "<string>",
"table": "<string>",
"qualified": "<string>",
"kind": "<string>",
"location": "<string>"
},
"state": "never",
"lastSyncAt": "<string>",
"lastRunId": "<string>",
"commentsHash": "<string>",
"tagsHash": "<string>",
"propertiesHash": "<string>",
"lastError": "<string>",
"lineageEnabled": true,
"lineage": "off",
"lineageHash": "<string>",
"lastLineageAt": "<string>",
"registerEnabled": true,
"register": "off",
"registeredMetadataLocation": "<string>",
"lastRegisterAt": "<string>",
"catalogMode": "register",
"restMetadataLocation": "<string>",
"lastRestCommitAt": "<string>",
"restRefusedReason": "<string>",
"restCreatedTable": "<string>"
}Authorizations
Response
Sync state
Iceberg register status. stale means Unity Catalog still points at an older metadata file of the table. With catalogMode: rest, rest means the last run committed through the catalog and refused means it wrote by path instead (see restRefusedReason). With catalogMode: managed, managed means the last run committed through the catalog at the catalog-chosen location (see restMetadataLocation).
off, never, registered, stale, error, rest, managed, refused 