Skip to content

Commit

Permalink
docs(structured-properties): example to read structured properties fr… (
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe-lyons authored Oct 11, 2024
1 parent f13dae1 commit 36fc0c4
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion docs/api/tutorials/structured-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,50 @@ Or you can run the following command to view the properties associated with the
datahub dataset get --urn {urn}
```

## Read Structured Properties From a Dataset

For reading all structured properties from a dataset:

<Tabs>
<TabItem value="graphql" label="GraphQL" default>

```graphql
query getDataset {
dataset(urn: "urn:li:dataset:(urn:li:dataPlatform:snowflake,long_tail_companions.ecommerce.customer,PROD)") {
structuredProperties {
properties {
structuredProperty {
urn
type
definition {
displayName
description
allowedValues {
description
}
}
}
values {
... on StringValue {
stringValue
}
... on NumberValue {
numberValue
}
}
valueEntities {
urn
type
}
}
}
}
}
```

</TabItem>
</Tabs>

## Remove Structured Properties From a Dataset

For removing a structured property or list of structured properties from a dataset:
Expand Down Expand Up @@ -1733,4 +1777,4 @@ Example Response:
```

</TabItem>
</Tabs>
</Tabs>

0 comments on commit 36fc0c4

Please sign in to comment.