你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get Artifact From DB - Get Artifact From DB

从数据库获取项目

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

URI 参数

名称 必需 类型 说明
artifactName
path True

string

项目名称。

artifactType
path True

SASEntityType

项目类型。

databaseName
path True

string

数据库名称。

endpoint
path True

string

url

工作区开发终结点,例如 https://myworkspace.dev.azuresynapse.net

api-version
query True

string

Synapse 客户端 API 版本。

响应

名称 类型 说明
200 OK

MDEntity

已成功返回的项目详细信息

Other Status Codes

CloudError

SyMS 错误响应。

示例

Get an artifact from database

示例请求

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

示例响应

{
  "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"
}
{
  "error": {
    "code": "Error code",
    "message": "SyMS response error message"
  }
}

定义

名称 说明
CloudError

定义Azure Synapse错误响应结构的对象。

MDEntity

MD 实体

SASEntityType

项目类型。

CloudError

定义Azure Synapse错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。

error.details

CloudError[]

包含其他错误详细信息的数组。

error.message

string

错误消息。

error.target

string

与错误关联的请求中的属性名称/路径。

MDEntity

MD 实体

名称 类型 说明
id

string

实体资源 ID。

name

string

实体名称。

properties

object

type

SASEntityType

项目类型。

SASEntityType

项目类型。

名称 类型 说明
DATABASE

string

FUNCTION

string

PARTITIONINFO

string

RELATIONSHIP

string

SCHEMA

string

TABLE

string

VIEW

string