Get Artifact From DB - Get Artifact From DB

Szolgáltatás:

Synapse

API-verzió:

2021-04-01

Összetevő lekérése adatbázisból

GET {endpoint}/databases/{databaseName}/{artifactType}s/{artifactName}?api-version=2021-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
artifactName	path	True	string	Összetevő neve.
artifactType	path	True	SASEntityType	Összetevő típusa.
databaseName	path	True	string	Adatbázis neve.
endpoint	path	True	string (url)	A munkaterület fejlesztési végpontja, például https://myworkspace.dev.azuresynapse.net.
api-version	query	True	string	A Synapse-ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	MDEntity	Az összetevő részleteinek visszaadva
Other Status Codes	CloudError	SyMS-hibaválasz.

Példák

Get an artifact from database

Mintakérelem

HTTP

GET exampleWorkspace.dev.azuresynapse.net/databases/exampleDatabase/TABLEs/exampleTableName?api-version=2021-04-01

Mintaválasz

Állapotkód:

200

{
  "name": "exampleTableName",
  "type": "TABLE",
  "properties": {
    "TableType": "MANAGED",
    "Namespace": {
      "SchemaName": null,
      "DatabaseName": "exampleDatabase"
    },
    "partitioning": null,
    "storageDescriptor": {
      "distribution": null,
      "columns": [
        {
          "name": "exampleColumn1Name",
          "originDataTypeName": {
            "typeFamily": null,
            "typeName": "string",
            "isTableType": false,
            "isComplexType": false,
            "isNullable": true,
            "length": 0,
            "precision": 0,
            "scale": 0,
            "properties": null
          }
        },
        {
          "name": "exampleColumn2Name",
          "originDataTypeName": {
            "typeFamily": null,
            "typeName": "string",
            "isTableType": false,
            "isComplexType": false,
            "isNullable": true,
            "length": 0,
            "precision": 0,
            "scale": 0,
            "properties": null
          }
        }
      ],
      "columnSetEntityName": "ColumnSetEntityNameGuid",
      "format": {
        "inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
        "outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
        "formatType": "textfile",
        "properties": {
          "serialization.format": "1"
        },
        "serDeName": null,
        "serializeLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe"
      },
      "source": {
        "provider": null,
        "location": "abfss://exampleBlobContainer@exampleStorageName.dfs.core.windows.net/exampleDatabase/exampleTableName",
        "properties": null
      },
      "properties": {
        "microsoft.catalog.internal.hive.sd.columns": "{\"columns\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\"},{\"name\":\"exampleColumn2Name\",\"type\":\"string\"}]}"
      },
      "serDeInfo": null,
      "isStoredAsSubdirectories": false
    },
    "temporary": false,
    "isRewriteEnabled": false,
    "viewOriginalText": null,
    "viewExpandedText": null,
    "originObjectId": null,
    "isSharedEntity": false,
    "publishStatus": "PUBLISHED",
    "properties": {
      "spark.sql.sources.schema.part.0": "{\"type\":\"struct\",\"fields\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"exampleColumn2Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}",
      "transient_lastDdlTime": "1646776703",
      "spark.sql.sources.schema.numParts": "1",
      "spark.sql.create.version": "3.1.2.5.0-57012673"
    },
    "objectVersion": 1,
    "objectId": "2fe342ca-9c81-4d5b-8aeb-6259b02b99e6"
  },
  "id": "/subscriptions/exampleSubscriptionIdGuid/resourcegroups/exampleResourceGroup/providers/microsoft.synapse/workspaces/exampleWorkspace/databases/exampleDatabase/exampleTableName"
}

Állapotkód:

default

{
  "error": {
    "code": "Error code",
    "message": "SyMS response error message"
  }
}

Definíciók

Name	Description
CloudError	A Azure Synapse hibaválasz struktúráját meghatározó objektum.
MDEntity	MD-entitás
SASEntityType	Összetevő típusa.

CloudError

Objektum

A Azure Synapse hibaválasz struktúráját meghatározó objektum.

Name	Típus	Description
error.code	string	Hibakód.
error.details	CloudError[]	Tömb további hiba részleteivel.
error.message	string	Hibaüzenet.
error.target	string	A kérelemben szereplő tulajdonságnév/elérési út hiba miatt van társítva.

MDEntity

Objektum

MD-entitás

Name	Típus	Description
id	string	Entitás erőforrás-azonosítója.
name	string	Entitás neve.
properties	object
type	SASEntityType	Összetevő típusa.

SASEntityType

Enumerálás

Összetevő típusa.

Érték	Description
DATABASE
FUNCTION
PARTITIONINFO
RELATIONSHIP
SCHEMA
TABLE
VIEW