Java SDK | Collate Java SDK Documentation

Learn to integrate Collate’s Java SDK into your applications. Complete documentation, code examples, and API reference for seamless metadata management.

Overview

Collate’s current Java SDK is the org.open-metadata:openmetadata-sdk module. It provides a simple initializer, a service-level client, and fluent helpers under org.openmetadata.sdk.fluent.*.

Start here

SDK overview

Installation, client setup, CRUD patterns, and fluent usage.

Lineage guide

Read and write lineage with the Java API layer.

Installation

Use the SDK version that matches your server release.

<dependency>
  <groupId>org.open-metadata</groupId>
  <artifactId>openmetadata-sdk</artifactId>
  <version>YOUR_OPENMETADATA_VERSION</version>
</dependency>

Basic client setup

import org.openmetadata.sdk.client.OpenMetadata;

OpenMetadata.initialize(
    "https://your-company.getcollate.io/api",
    "your-jwt-token"
);

var client = OpenMetadata.client();

Common entry points

• OpenMetadata.client() returns the service-level client for tables(), glossaries(), databaseServices(), and similar REST-backed operations.
• org.openmetadata.sdk.fluent.Tables, Glossaries, Users, and related helpers provide a higher-level fluent layer after you set a default client.
• The lineage guide uses org.openmetadata.sdk.api.Lineage on top of the same initialized client.