Skip to main content

Glossary attributes

These attributes only exist on glossary-related objects in Atlan (terms and categories). Attempting to search for them on other asset types will produce no results.

[Atlas]GlossaryTerm.ANCHOR ​

The qualifiedName of the glossary in which the term is contained in Atlan.

Build the query and request
IndexSearchRequest index = client.assets.select() // (1)
    .where(GlossaryTerm.ANCHOR.eq("hvhGIKJi7N4xrUhyy8SAP")) // (2)
    .includeOnResults(GlossaryTerm.ANCHOR) // (3)
    .toRequest();

  1. You can search across all assets using the select() method of the assets member on any client. (For details, see Searching for assets.)

  2. Then provide the exact, full qualifiedName of the glossary in the eq() predicate. This uses a term query to exactly match the qualifiedName.

    Equivalent query from Elastic
    Query byGlossary = TermQuery.of(t -> t
        .field("__glossary")
        .value("hvhGIKJi7N4xrUhyy8SAP"))
      ._toQuery();

  3. To make sure the details of this field are included in each result, add the field to includeOnResults().

Run the search
for (Asset result : index.search(client))
}
  1. For details, see Searching for assets.
  2. The parent glossary can be retrieved from a result through .getAnchor(), but only after the result has been cast to the appropriate type (GlossaryTerm).

[Atlas]GlossaryCategory.ANCHOR ​

The qualifiedName of the glossary in which the category is contained in Atlan.

Build the query and request
IndexSearchRequest index = client.assets.select() // (1)
    .where(GlossaryCategory.ANCHOR.eq("hvhGIKJi7N4xrUhyy8SAP")) // (2)
    .includeOnResults(GlossaryCategory.ANCHOR) // (3)
    .toRequest();

  1. You can search across all assets using the select() method of the assets member on any client. (For details, see Searching for assets.)

  2. Then provide the exact, full qualifiedName of the glossary in the eq() predicate. This uses a term query to exactly match the qualifiedName.

    Equivalent query from Elastic
    Query byGlossary = TermQuery.of(t -> t
        .field("__glossary")
        .value("hvhGIKJi7N4xrUhyy8SAP"))
      ._toQuery();

  3. To make sure the details of this field are included in each result, add the field to includeOnResults().

Run the search
for (Asset result : index.search(client))
}
  1. For details, see Searching for assets.
  2. The parent glossary can be retrieved from a result through .getAnchor(), but only after the result has been cast to the appropriate type (GlossaryCategory).

[Atlas]GlossaryTerm.CATEGORIES ​

The qualifiedName of one or more categories in which the term is organized in Atlan.

Build the query and request
IndexSearchRequest index = client.assets.select() // (1)
    .where(GlossaryTerm.CATEGORIES.in( // (2)
        List.of("Y5kzMdHDHbKWncb3EK1w8@hvhGIKJi7N4xrUhyy8SAP",
                "SWpBeZFipHmXhSvxUrVNw@hvhGIKJi7N4xrUhyy8SAP")));
    .includeOnResults(GlossaryTerm.CATEGORIES) // (3)
    .toRequest();

  1. You can search across all assets using the select() method of the assets member on any client. (For details, see Searching for assets.)

  2. Then provide the exact, full qualifiedName of one or more categories in the in() predicate. This uses a terms query to exactly match the qualifiedName.

    Equivalent query from Elastic
    Query byCategory = TermsQuery.of(t -> t
        .field("__categories")
        .terms(TermsQueryField.of(f -> f
            .value(List.of(FieldValue.of("Y5kzMdHDHbKWncb3EK1w8@hvhGIKJi7N4xrUhyy8SAP"),
                           FieldValue.of("SWpBeZFipHmXhSvxUrVNw@hvhGIKJi7N4xrUhyy8SAP"))))))
      ._toQuery();

  3. To make sure the details of this field are included in each result, add the field to includeOnResults().

Run the search
for (Asset result : index.search(client))
}
  1. For details, see Searching for assets.
  2. The categories organizing the term can be retrieved from a result through .getCategories(), but only after the result has been cast to the appropriate type (GlossaryTerm).

[Atlas]GlossaryCategory.PARENT_CATEGORY ​

The qualifiedName of the parent category in which a subcategory is contained in Atlan.

Build the query and request
IndexSearchRequest index = client.assets.select() // (1)
    .where(GlossaryCategory.PARENT_CATEGORY.eq("Y5kzMdHDHbKWncb3EK1w8@hvhGIKJi7N4xrUhyy8SAP")) // (2)
    .includeOnResults(GlossaryCategory.PARENT_CATEGORY) // (3)
    .toRequest();

  1. You can search across all assets using the select() method of the assets member on any client. (For details, see Searching for assets.)

  2. Then provide the exact, full qualifiedName the parent category in the eq() predicate. This uses a term query to exactly match the qualifiedName.

    Equivalent query from Elastic
    Query byParentCategory = TermQuery.of(t -> t
        .field("__parentCategory")
        .value("Y5kzMdHDHbKWncb3EK1w8@hvhGIKJi7N4xrUhyy8SAP"))
      ._toQuery();

  3. To make sure the details of this field are included in each result, add the field to includeOnResults().

Run the search
for (Asset result : index.search(client))
}
  1. For details, see Searching for assets.
  2. The parent category in which the subcategory is contained can be retrieved from a result through .getParentCategory(), but only after the result has been cast to the appropriate type (GlossaryCategory).
Was this page helpful?