Skip to main content
POST
/
v1
/
schemaDesign:diffMetadata
cURL
curl --request POST \
  --url https://api.example.com/v1/schemaDesign:diffMetadata \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceMetadata": {
    "labels": {},
    "lastSyncTime": "2023-11-07T05:31:56Z",
    "backupAvailable": true,
    "datashare": true,
    "drifted": true,
    "version": "<string>"
  },
  "targetMetadata": {
    "labels": {},
    "lastSyncTime": "2023-11-07T05:31:56Z",
    "backupAvailable": true,
    "datashare": true,
    "drifted": true,
    "version": "<string>"
  },
  "sourceCatalog": {
    "name": "<string>",
    "schemas": [
      {
        "name": "<string>",
        "tables": [
          {
            "name": "<string>",
            "columns": {
              "columns": [
                {
                  "name": "<string>",
                  "semanticType": "<string>",
                  "labels": {},
                  "classification": "<string>",
                  "objectSchema": {
                    "type": "TYPE_UNSPECIFIED",
                    "structKind": {
                      "properties": {}
                    },
                    "arrayKind": {
                      "kind": "<unknown>"
                    },
                    "semanticType": "<string>"
                  }
                }
              ]
            },
            "objectSchema": {
              "type": "TYPE_UNSPECIFIED",
              "structKind": {
                "properties": {}
              },
              "arrayKind": {
                "kind": "<unknown>"
              },
              "semanticType": "<string>"
            },
            "classification": "<string>"
          }
        ]
      }
    ]
  },
  "targetCatalog": {
    "name": "<string>",
    "schemas": [
      {
        "name": "<string>",
        "tables": [
          {
            "name": "<string>",
            "columns": {
              "columns": [
                {
                  "name": "<string>",
                  "semanticType": "<string>",
                  "labels": {},
                  "classification": "<string>",
                  "objectSchema": {
                    "type": "TYPE_UNSPECIFIED",
                    "structKind": {
                      "properties": {}
                    },
                    "arrayKind": {
                      "kind": "<unknown>"
                    },
                    "semanticType": "<string>"
                  }
                }
              ]
            },
            "objectSchema": {
              "type": "TYPE_UNSPECIFIED",
              "structKind": {
                "properties": {}
              },
              "arrayKind": {
                "kind": "<unknown>"
              },
              "semanticType": "<string>"
            },
            "classification": "<string>"
          }
        ]
      }
    ]
  },
  "engine": "ENGINE_UNSPECIFIED"
}
'
{
  "diff": "<string>"
}

Body

application/json
​
sourceMetadata
object
required

The metadata of the source schema.

​
targetMetadata
object
required

The metadata of the target schema.

​
sourceCatalog
object

Catalog metadata for a database including schemas, tables, and columns.

​
targetCatalog
object

Catalog metadata for a database including schemas, tables, and columns.

​
engine
enum<string>

The database engine of the schema.

Available options:
ENGINE_UNSPECIFIED,
CLICKHOUSE,
MYSQL,
POSTGRES,
SNOWFLAKE,
SQLITE,
TIDB,
MONGODB,
REDIS,
ORACLE,
SPANNER,
MSSQL,
REDSHIFT,
MARIADB,
OCEANBASE,
STARROCKS,
DORIS,
HIVE,
ELASTICSEARCH,
BIGQUERY,
DYNAMODB,
DATABRICKS,
COCKROACHDB,
COSMOSDB,
TRINO,
CASSANDRA

Response

OK

​
diff
string

The diff of the metadata.