Descriptions
Get list of descriptions of databases, tables, and objects.
Table Specific Information
Select
The driver will use the Azure Data Catalog API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.
- Name supports the '=, !=, <>, CONTAINS' operators.
- Timestamp supports the '=, <, <=, >, >=, CONTAINS' operators.
- LastRegisteredTime supports the '=, CONTAINS' operators.
- ObjectType supports the '=' operator.
- SourceType supports the '=' operator.
- FriendlyName supports the '=, CONTAINS' operators.
- Experts supports the '=, CONTAINS' operators.
- Description supports the '=, CONTAINS' operators.
- Tags supports the '=, !=, <>, CONTAINS' operators.
- HasTags supports the '=' operator.
- HasPreviews supports the '=' operator.
- HasDocumentation supports the '=' operator.
- HasTableDataProfiles supports the '=' operator.
- HasColumnsDataProfiles supports the '=' operator.
- HasDescription supports the '=' operator.
- View supports the '=' operator.
- Facets supports the '=' operator.
SELECT * FROM Descriptions WHERE CONTAINS(Description, 'sakila') AND ObjectType = table;
SELECT * FROM Descriptions WHERE CONTAINS(Name, 'customer') AND HasTags = true;
Columns
| Name | Type | Description |
| Id | String | Id of a description. |
| Type | String | Type of description. |
| EffectiveRights | String | Rights a particular annotation has. |
| PropertyDescription | String | Content in description. |
| PropertyFromSourceSystem | Boolean | Indicates whether data of an item is derived from a source system or authored by a user. |
| PropertyKey | String | Key of a description. |
| Roles | String | Roles of a description. |
| RoleMembers | String | Members whom roles was assigned. |
| Timestamp | Datetime | Created time of description. |
| Name | String | Name of a table, database, object. |
| ObjectType | String | Type of object. Eg. table, etc. |
| SourceType | String | Source type. Eg. Jdbc, Odbc, etc. |
| FriendlyName | String | Check items where the search term appears in the data source friendly name. |
| Experts | String | Check items where the data source expert matches the search term. |
| Description | String | Content of a description. |
| Tags | String | Tags available in descriptions. |
| HasTags | Boolean | Check items that have a tag. |
| HasPreviews | Boolean | Check items that contain preview. |
| HasDocumentation | Boolean | Check items that contain documentation. |
| HasTableDataProfiles | Boolean | Check items that have a table profile. |
| HasColumnsDataProfiles | Boolean | Check items that have a columns data profile. |
| HasDescription | Boolean | Check items that have a description. |
| View | String | Name of the view the client wants to see. |
| Facets | String | A comma separated field names to facet the results on. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LastRegisteredTime | Date | Date and time when the metadata was registered. |