Skip to main content

Java SDK Glossary Relations

The Java software development kit (SDK) exposes typed glossary relations through GlossaryRelationTypes and GlossaryTerms in org.openmetadata.sdk.fluent. Initialize the SDK client through OM.init(client) before using the static fluent entry points.

Discover Relation Types

Use GlossaryRelationTypes to list, filter, and look up configured relation types:
settings() returns the complete glossary relation configuration. usage() returns a map of relation-type name to usage count, while usageDetailed() returns the typed usage objects. Administrators can register a type. Repeating the call for the same name does not create a duplicate.

Add and Remove Typed Relations

The term identifiers can be universally unique identifiers (UUIDs) or fully qualified names.
relateTo(...).apply() defaults to the relatedTo type when .as(...) is omitted. unrelateFrom(...).apply() intentionally has a different default: it removes all relation types between the two terms.

Read a Relation Graph

Use relations() to traverse the relation graph from a term:
The default traversal depth is 1. If ofTypes(...) is omitted, the graph includes all relation types.