OpenMetadata

https://docs.open-metadata.org/
Admin
OpenMetadata is an end-to-end metadata management platform that enables organizations to document,...
Tokens:1,953,029
Snippets:14,044
Trust Score:9.1
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example installation command

Source: https://docs.open-metadata.org/v2.0.x/deployment/ingestion/external/airflow

Example of installing openmetadata-ingestion with specific plugins and version.

```bash
pip3 install openmetadata-ingestion[mysql,snowflake,s3]==2.0.2.0
```

--------------------------------

### Install Nginx

Source: https://docs.open-metadata.org/v2.0.x/deployment/security/enable-ssl/nginx

Commands to install and start Nginx on Ubuntu. Run these as root or with sudo.

```bash
sudo apt update
sudo apt install nginx
sudo systemctl start nginx

```

--------------------------------

### GET /api/v1/tables

Source: https://docs.open-metadata.org/api-reference

Lists tables in the catalog. This endpoint is used in the quick start example to retrieve a list of tables with a limit parameter.

```APIDOC
## [GET] /api/v1/tables

### Description
Lists tables in the catalog. This endpoint is used in the quick start example to retrieve a list of tables with a limit parameter.

### Method
GET

### Endpoint
/api/v1/tables

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of tables to return.

### Request Example
```
curl -X GET "https://your-company.open-metadata.org/api/v1/tables?limit=10" \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json"
```

### Response
#### Success Response (200)
- **data** (array) - List of table objects.

#### Response Example
```
{
  "data": [
    {
      "fullyQualifiedName": "string",
      "description": "string"
    }
  ]
}
```
```

--------------------------------

### Quickstart with RDF using docker-compose-rdf.yml

Source: https://docs.open-metadata.org/deployment/rdf-knowledge-graph

Runs the full stack (MySQL, Elasticsearch, Fuseki, migrations, server, ingestion) with RDF enabled from the start. This is not the default quickstart; RDF support is opt-in via this separate compose file.

```bash
git clone https://github.com/open-metadata/OpenMetadata.git
cd OpenMetadata/docker/docker-compose-quickstart
docker compose -f docker-compose-rdf.yml up -d

```

--------------------------------

### Dockerfile for Custom Ingestion Image

Source: https://docs.open-metadata.org/v2.0.x/connectors/custom-connectors

Dockerfile example for building a custom ingestion image that includes your connector package. It starts from the openmetadata/ingestion image, copies the connector code and setup.py, and installs the package without dependencies.

```dockerfile
# Base image from the right version
FROM openmetadata/ingestion:<version>

# Let's use the same workdir as the ingestion image
WORKDIR ingestion
USER airflow

# Install our custom connector
# For a PROD image, this could be picking up the package from your private package index
COPY connector connector
COPY setup.py .
RUN pip install --no-deps .

```

--------------------------------

### Installation with Database Connectors

Source: https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/getting-started

Installs the SDK with database-specific extras for PostgreSQL, MySQL, BigQuery, or a combination. Use the appropriate extra for the databases you plan to test.

```bash
# For PostgreSQL
pip install "openmetadata-ingestion[postgres]>=1.11.0.0"

# For MySQL
pip install "openmetadata-ingestion[mysql]>=1.11.0.0"

# For BigQuery
pip install "openmetadata-ingestion[bigquery]>=1.11.0.0"

# For multiple databases
pip install "openmetadata-ingestion[postgres,mysql,bigquery]>=1.11.0.0"

```

--------------------------------

### GET /v1/mlmodels Response Example

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/mlmodels/list

Example JSON response from GET /v1/mlmodels, showing a single ML model object and paging information.

```json
{
  "data": [
    {
      "id": "6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2",
      "name": "customer_segmentation",
      "fullyQualifiedName": "mlflow_svc.customer_segmentation",
      "displayName": "Customer Segmentation Model",
      "algorithm": "KMeans",
      "version": 0.1,
      "updatedAt": 1769982669247,
      "updatedBy": "admin",
      "service": {
        "id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
        "type": "mlmodelService",
        "name": "mlflow_svc",
        "fullyQualifiedName": "mlflow_svc",
        "deleted": false
      },
      "serviceType": "Mlflow",
      "href": "http://localhost:8585/api/v1/mlmodels/6b04e1d8-b66d-4f78-ab21-beb5be2cf4f2",
      "deleted": false,
      "owners": [],
      "tags": [],
      "followers": [],
      "votes": {
        "upVotes": 0,
        "downVotes": 0
      },
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

```

--------------------------------

### Build the package

Source: https://docs.open-metadata.org/v2.0.x/connectors/drive/custom-drive

Build the package using setuptools.

```bash
python setup.py sdist

```

--------------------------------

### Start OpenMetadata server

Source: https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/openmetadata-ui

Starts the OpenMetadata server locally from the directory `openmetadata-dist/target/openmetadata-*-SNAPSHOT`. Run this before starting the UI.

```bash
./bin/openmetadata-server-start.sh conf/openmetadata.yaml
```

--------------------------------

### Get method signature and example

Source: https://docs.open-metadata.org/v2.0.x/api-reference/sdk/go-api-methods

The Get method signature and an example call to retrieve a table resource. The example sets the path to "tables" and passes nil for header, extraHeader, and queryParams.

```go
func (rest Rest) Get(
	path string,
	header http.Header,
	extraHeader map[string][]string,
	queryParams map[string]string) (map[string]any, error)

```

```go
// main.go
...
func main() {
    ...
    path := "tables"
	body, err := rest.Get(path, nil, nil, nil)
}

```

--------------------------------

### Install Go SDK

Source: https://docs.open-metadata.org/api-reference

Install the OpenMetadata Go SDK using go get. Provides a type-safe Go API for OpenMetadata backend integration.

```bash
go get github.com/open-metadata/openmetadata-sdk/openmetadata-go-client
```

--------------------------------

### Example response for GET /v1/databaseSchemas

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/database-schemas/list

Example response from the GET /v1/databaseSchemas endpoint, showing a schema entity with service, database, tables, and paging information.

```json
{
  "data": [
    {
      "id": "f681432b-e66c-4096-a1cd-7771358c5323",
      "name": "information_schema",
      "fullyQualifiedName": "Glue.default.information_schema",
      "description": "This **mock** database contains tables related to the Glue service",
      "version": 0.1,
      "updatedAt": 1769982658171,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/databaseSchemas/f681432b-e66c-4096-a1cd-7771358c5323",
      "owners": [],
      "service": {
        "id": "0fab117a-4c58-4ebb-9d42-beab0768fa8e",
        "type": "databaseService",
        "name": "Glue",
        "fullyQualifiedName": "Glue",
        "displayName": "Glue",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/services/databaseServices/0fab117a-4c58-4ebb-9d42-beab0768fa8e"
      },
      "serviceType": "Glue",
      "database": {
        "id": "9655ba5b-b8d7-419c-98f4-16b976692ad8",
        "type": "database",
        "name": "default",
        "fullyQualifiedName": "Glue.default",
        "description": "This **mock** database contains tables related to the Glue service",
        "displayName": "default",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databases/9655ba5b-b8d7-419c-98f4-16b976692ad8"
      },
      "tables": [
        {
          "id": "49cae725-62e6-48b4-b604-7ea915659d9a",
          "type": "table",
          "name": "sales",
          "fullyQualifiedName": "Glue.default.information_schema.sales",
          "description": "Sales data",
          "displayName": "sales",
          "deleted": false,
          "href": "http://localhost:8585/api/v1/tables/49cae725-62e6-48b4-b604-7ea915659d9a"
        },
        {
          "id": "b9988329-cb3e-469b-8d10-d6a21de8b0b9",
          "type": "table",
          "name": "marketing",
          "fullyQualifiedName": "Glue.default.information_schema.marketing",
          "description": "Marketing data",
          "displayName": "marketing",
          "deleted": false,
          "href": "http://localhost:8585/api/v1/tables/b9988329-cb3e-469b-8d10-d6a21de8b0b9"
        }
      ],
      "tags": [],
      "deleted": false,
      "sourceUrl": "https://www.glue.com/information_schema",
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "...",
    "total": 28
  }
}

```

--------------------------------

### Example response for GET /v1/storedProcedures

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/stored-procedures/list

Example JSON response from the GET /v1/storedProcedures endpoint. Shows a stored procedure entity with metadata, code, and paging information.

```json
{
  "data": [
    {
      "id": "d02b24fa-a246-4563-adf1-9ad21f251c0e",
      "name": "calculate_average",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.calculate_average",
      "description": "Procedure to calculate average",
      "storedProcedureCode": {
        "code": "CREATE OR REPLACE PROCEDURE calculate_average(numbers INT ARRAY) RETURNS FLOAT NOT NULL LANGUAGE SQL AS $$DECLARE sum_val INT = 0;count_val INT = 0;average_val FLOAT;BEGIN\n  FOR num IN ARRAY numbers DO sum_val := sum_val + num;\n  count_val := count_val + 1;\nEND FOR;\nIF count_val = 0 THEN\n  average_val := 0.0;\nELSE\n  average_val := sum_val / count_val;\nEND IF;\nRETURN average_val;\nEND;$$;"
      },
      "version": 0.1,
      "updatedAt": 1769982660822,
      "updatedBy": "admin",
      "storedProcedureType": "StoredProcedure",
      "href": "http://localhost:8585/api/v1/storedProcedures/d02b24fa-a246-4563-adf1-9ad21f251c0e",
      "databaseSchema": {
        "id": "4dd30184-009c-4792-b296-9562eaed651f",
        "type": "databaseSchema",
        "name": "shopify",
        "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
        "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
        "displayName": "shopify",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
      },
      "database": {
        "id": "0be090de-0941-48c4-af49-a6157c91cda0",
        "type": "database",
        "name": "ecommerce_db",
        "fullyQualifiedName": "sample_data.ecommerce_db",
        "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
        "displayName": "ecommerce_db",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
      },
      "serviceType": "BigQuery",
      "deleted": false,
      "owners": [],
      "tags": [],
      "domains": [],
      "processedLineage": false,
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "...",
    "total": 12
  }
}

```

--------------------------------

### Installation with Multiple Features

Source: https://docs.open-metadata.org/v2.0.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/getting-started

Installs the SDK with multiple extras combined, such as pandas with Postgres or with pyarrow for comprehensive ETL support.

```bash
# For DataFrame validation with Postgres support
pip install "openmetadata-ingestion[pandas,postgres]>=1.11.0.0"

# For comprehensive ETL support
pip install "openmetadata-ingestion[pandas,postgres,pyarrow]>=1.11.0.0"

```

--------------------------------

### Example response for GET /v1/tables

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/tables/list

Example JSON response from the GET /v1/tables endpoint showing a table entity with columns, databaseSchema, database, service, and paging information.

```json
{
  "data": [
    {
      "id": "455e3d9d-dbbf-455e-b3be-7191daa825f3",
      "name": "agent_performance_summary",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary",
      "description": "Summary of agent performance metrics derived from multiple tables including ssot_utilization_detail for comprehensive reporting.",
      "version": 0.1,
      "updatedAt": 1769982651320,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3",
      "tableType": "Regular",
      "columns": [
        {
          "name": "agent_id",
          "dataType": "VARCHAR",
          "dataLength": 100,
          "dataTypeDisplay": "varchar",
          "description": "Agent identifier",
          "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.agent_id",
          "tags": [],
          "ordinalPosition": 1
        },
        {
          "name": "performance_score",
          "dataType": "DECIMAL",
          "dataTypeDisplay": "decimal",
          "description": "Overall performance score",
          "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.performance_score",
          "tags": [],
          "ordinalPosition": 2
        }
      ],
      "owners": [],
      "databaseSchema": {
        "id": "4dd30184-009c-4792-b296-9562eaed651f",
        "type": "databaseSchema",
        "name": "shopify",
        "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
        "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
        "displayName": "shopify",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
      },
      "database": {
        "id": "0be090de-0941-48c4-af49-a6157c91cda0",
        "type": "database",
        "name": "ecommerce_db",
        "fullyQualifiedName": "sample_data.ecommerce_db",
        "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
        "displayName": "ecommerce_db",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
      },
      "service": {
        "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
        "type": "databaseService",
        "name": "sample_data",
        "fullyQualifiedName": "sample_data",
        "displayName": "sample_data",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09"
      },
      "serviceType": "BigQuery",
      "tags": [],
      "deleted": false
    }
  ],
  "paging": {
    "after": "eyJsYXN0SWQiOiI0NTVlM2Q5ZC1kYmJmLTQ1NWUtYjNiZS03MTkxZGFhODI1ZjMifQ==",
    "total": 299
  }
}

```

--------------------------------

### Set up Python development environment

Source: https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development/install-skills

Creates a Python 3.11 virtual environment, activates it, and installs development dependencies. Required before installing skills.

```bash
python3.11 -m venv env
source env/bin/activate
make install_dev generate

```

--------------------------------

### Example response for GET /v1/pipelines

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/pipelines/list

Example JSON response from GET /v1/pipelines. Contains a data array with pipeline objects and a paging object with after cursor and total count.

```json
{
  "data": [
    {
      "id": "538faa63-d204-46ff-aead-d158d0401cac",
      "name": "dbt_analytics_customers",
      "displayName": "DBT Customer Analytics",
      "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
      "version": 0.1,
      "updatedAt": 1769982668397,
      "updatedBy": "admin",
      "service": {
        "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
        "type": "pipelineService",
        "name": "sample_airflow",
        "fullyQualifiedName": "sample_airflow",
        "deleted": false
      },
      "serviceType": "DBTCloud",
      "href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
      "deleted": false,
      "owners": [],
      "tags": [],
      "followers": [],
      "votes": {
        "upVotes": 0,
        "downVotes": 0
      },
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

```

--------------------------------

### Example response for GET /v1/databases

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/databases/list

Example JSON response from GET /v1/databases. Shows a database entity with fields like fullyQualifiedName, service, databaseSchemas, and paging information.

```json
{
  "data": [
    {
      "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "name": "default",
      "fullyQualifiedName": "mysql_sample.default",
      "tags": [],
      "version": 0.1,
      "updatedAt": 1769982658682,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
      "owners": [],
      "service": {
        "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
        "type": "databaseService",
        "name": "mysql_sample",
        "fullyQualifiedName": "mysql_sample",
        "displayName": "mysql_sample",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
      },
      "serviceType": "Mysql",
      "databaseSchemas": [
        {
          "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
          "type": "databaseSchema",
          "name": "posts_db",
          "fullyQualifiedName": "mysql_sample.default.posts_db",
          "displayName": "posts_db",
          "deleted": false,
          "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
        }
      ],
      "default": false,
      "deleted": false,
      "sourceUrl": "https://localhost:3306/posts_db",
      "domains": [],
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "eyJsYXN0SWQiOiIxZDA4YzJjNi1jZWE3LTRhZGYtOTA0My0wZjZhNmFhZjk3MjEifQ==",
    "total": 8
  }
}

```

--------------------------------

### Set up development environment

Source: https://docs.open-metadata.org/v2.0.x/developers/contribute/developing-a-new-connector/ai-assisted-development/scaffold-connector

Sets up the development environment before using the scaffold tool. Run these commands from the OpenMetadata repository root.

```bash
cd OpenMetadata
python3.11 -m venv env
source env/bin/activate
make install_dev generate

```

--------------------------------

### Example openmetadata.yaml configuration

Source: https://docs.open-metadata.org/v2.0.x/deployment/bare-metal/subpath

A complete example of the relevant section of openmetadata.yaml, combining basePath, publicKeyUrl, server, and assets settings.

```yaml
basePath: ${BASE_PATH:-/openmetadata}/
publicKeyUrl: ${BASE_PATH:-/}api/v1/system/config/jwks

server:
  applicationContextPath: ${BASE_PATH:-/openmetadata}
  rootPath: ${BASE_PATH:-/openmetadata}api/*

assets:
  resourcePath: /openmetadata/assets/
  uriPath: ${BASE_PATH:-/openmetadata}

```

--------------------------------

### Example response for GET /v1/databases/{id}

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/databases/retrieve

Example JSON response from the GET /v1/databases/{id} endpoint. Shows the database entity structure including service, databaseSchemas, and metadata fields.

```json
{
  "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "name": "default",
  "fullyQualifiedName": "mysql_sample.default",
  "tags": [],
  "version": 0.1,
  "updatedAt": 1769982658682,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "owners": [],
  "service": {
    "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
    "type": "databaseService",
    "name": "mysql_sample",
    "fullyQualifiedName": "mysql_sample",
    "displayName": "mysql_sample",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
  },
  "serviceType": "Mysql",
  "databaseSchemas": [
    {
      "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
      "type": "databaseSchema",
      "name": "posts_db",
      "fullyQualifiedName": "mysql_sample.default.posts_db",
      "displayName": "posts_db",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
    }
  ],
  "default": false,
  "deleted": false,
  "sourceUrl": "https://localhost:3306/posts_db",
  "domains": [],
  "entityStatus": "Unprocessed"
}
```

--------------------------------

### Minimal setup.py for custom drive connector

Source: https://docs.open-metadata.org/v2.0.x/connectors/drive/custom-drive

Minimal setup.py to package the custom drive connector as a Python module.

```python
from setuptools import setup, find_packages

setup(
    name="custom_drive_connector",
    version="0.1",
    packages=find_packages(),
    install_requires=[],
)

```

--------------------------------

### Bootstrap the database with openmetadata-ops.sh

Source: https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/openmetadata-server

Extract the distribution tar.gz file and run this command to drop and create the database. The script simplifies setup by handling Java dependencies, configurations, and environment variables automatically.

```bash
cd open-metadata-<version>
sh bootstrap/openmetadata-ops.sh drop-create

```

--------------------------------

### GET /v1/users response example

Source: https://docs.open-metadata.org/v2.0.x/api-reference/teams-and-users/users/list

Example JSON response from the GET /v1/users endpoint, showing a user object with fields like id, name, email, teams, roles, and paging information.

```json
{
  "data": [
    {
      "id": "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
      "name": "aaron_johnson0",
      "fullyQualifiedName": "aaron_johnson0",
      "displayName": "Aaron Johnson",
      "version": 0.1,
      "updatedAt": 1769982624214,
      "updatedBy": "admin",
      "email": "aaron_johnson0@gmail.com",
      "href": "http://localhost:8585/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
      "isBot": false,
      "isAdmin": false,
      "allowImpersonation": false,
      "teams": [
        {
          "id": "7a2b921b-f623-4eb5-9736-649788ad842c",
          "type": "team",
          "name": "Sales",
          "fullyQualifiedName": "Sales",
          "displayName": "Sales",
          "deleted": false
        }
      ],
      "personas": [],
      "deleted": false,
      "roles": [
        {
          "id": "761c2bb2-0b77-4bc5-9af9-cf89536d6a12",
          "type": "role",
          "name": "DataSteward",
          "fullyQualifiedName": "DataSteward",
          "displayName": "Data Steward",
          "deleted": false
        }
      ],
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 117
  }
}
```

--------------------------------

### Example response for GET /v1/teams

Source: https://docs.open-metadata.org/v2.0.x/api-reference/teams-and-users/teams/list

Example JSON response from GET /v1/teams. Shows a team object with fields like id, teamType, name, fullyQualifiedName, parents, users, and paging information.

```json
{
  "data": [
    {
      "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
      "teamType": "Group",
      "name": "Accounting",
      "fullyQualifiedName": "Accounting",
      "version": 0.1,
      "updatedAt": 1769982623753,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
      "parents": [
        {
          "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
          "type": "team",
          "name": "Finance",
          "fullyQualifiedName": "Finance",
          "displayName": "Finance",
          "deleted": false
        }
      ],
      "users": [
        {
          "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
          "type": "user",
          "name": "andrew_jennings3",
          "fullyQualifiedName": "andrew_jennings3",
          "displayName": "Andrew Jennings",
          "deleted": false
        }
      ],
      "deleted": false,
      "owners": [],
      "domains": [],
      "children": [],
      "policies": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 25
  }
}
```

--------------------------------

### Install Go SDK

Source: https://docs.open-metadata.org/v2.0.x/sdk/go

Installation command for the OpenMetadata Go SDK.

```APIDOC
## [SDK] Install Go SDK

### Description
Install the OpenMetadata Go SDK module using `go get`.

### Installation Command
```
go get github.com/open-metadata/openmetadata-sdk/openmetadata-go-client
```
```

--------------------------------

### GET /v1/lineage Response Example

Source: https://docs.open-metadata.org/v2.0.x/api-reference/lineage/add

Example response body for the GET /v1/lineage endpoint. Shows the entity, nodes, and downstream edges with lineage details including SQL query and column lineage.

```json
{
  "entity": {
    "id": "e7bee99b-5c5e-43ec-805c-8beba04804f5",
    "type": "table",
    "name": "source_table",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.source_table",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/tables/e7bee99b-5c5e-43ec-805c-8beba04804f5"
  },
  "nodes": [
    {
      "id": "800caa0f-a149-48d2-a0ce-6ca84501767e",
      "type": "table",
      "name": "target_table",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.target_table",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/tables/800caa0f-a149-48d2-a0ce-6ca84501767e"
    }
  ],
  "upstreamEdges": [],
  "downstreamEdges": [
    {
      "fromEntity": "e7bee99b-5c5e-43ec-805c-8beba04804f5",
      "toEntity": "800caa0f-a149-48d2-a0ce-6ca84501767e",
      "lineageDetails": {
        "sqlQuery": "INSERT INTO target SELECT id, name FROM source",
        "columnsLineage": [
          {
            "fromColumns": [
              "sample_data.ecommerce_db.shopify.source_table.id"
            ],
            "toColumn": "sample_data.ecommerce_db.shopify.target_table.id"
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Install OpenMetadata Helm chart

Source: https://docs.open-metadata.org/v2.0.x/quick-start/local-kubernetes-deployment

Installs the OpenMetadata application Helm chart and shows the expected `kubectl get pods --selector=app.kubernetes.io/name=openmetadata` output. Wait for the pod to be running and ready.

```bash
helm install openmetadata open-metadata/openmetadata

```

```bash
NAME                            READY   STATUS    RESTARTS   AGE
openmetadata-5c55f6759c-52dvq   1/1     Running   0          90s

```

--------------------------------

### Load sample data into the database

Source: https://docs.open-metadata.org/v2.0.x/developers/contribute/build-code-and-run-tests/openmetadata-server

Runs a series of commands to set up a Python virtual environment, install dependencies, and ingest sample data and usage. Execute from the top-level directory with the OpenMetadata service running.

```bash
python3 -m venv venv
source venv/bin/activate
make install_dev generate
cd ingestion
pip install -e '.[sample-data, elasticsearch]'
metadata ingest -c ./pipelines/sample_data.json
metadata usage -c ./pipelines/sample_usage.json

```

--------------------------------

### Example response for GET /v1/storedProcedures

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/stored-procedures/list

Example JSON response from GET /v1/storedProcedures. Shows a stored procedure entity with fields like id, name, fullyQualifiedName, storedProcedureCode, databaseSchema, database, serviceType, and paging information.

```json
{
  "data": [
    {
      "id": "d02b24fa-a246-4563-adf1-9ad21f251c0e",
      "name": "calculate_average",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.calculate_average",
      "description": "Procedure to calculate average",
      "storedProcedureCode": {
        "code": "CREATE OR REPLACE PROCEDURE calculate_average(numbers INT ARRAY) RETURNS FLOAT NOT NULL LANGUAGE SQL AS $$DECLARE sum_val INT = 0;count_val INT = 0;average_val FLOAT;BEGIN\n  FOR num IN ARRAY numbers DO sum_val := sum_val + num;\n  count_val := count_val + 1;\nEND FOR;\nIF count_val = 0 THEN\n  average_val := 0.0;\nELSE\n  average_val := sum_val / count_val;\nEND IF;\nRETURN average_val;\nEND;$$;"
      },
      "version": 0.1,
      "updatedAt": 1769982660822,
      "updatedBy": "admin",
      "storedProcedureType": "StoredProcedure",
      "href": "http://localhost:8585/api/v1/storedProcedures/d02b24fa-a246-4563-adf1-9ad21f251c0e",
      "databaseSchema": {
        "id": "4dd30184-009c-4792-b296-9562eaed651f",
        "type": "databaseSchema",
        "name": "shopify",
        "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
        "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
        "displayName": "shopify",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
      },
      "database": {
        "id": "0be090de-0941-48c4-af49-a6157c91cda0",
        "type": "database",
        "name": "ecommerce_db",
        "fullyQualifiedName": "sample_data.ecommerce_db",
        "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
        "displayName": "ecommerce_db",
        "deleted": false,
        "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
      },
      "serviceType": "BigQuery",
      "deleted": false,
      "owners": [],
      "tags": [],
      "domains": [],
      "processedLineage": false,
      "entityStatus": "Unprocessed"
    }
  ],
  "paging": {
    "after": "...",
    "total": 12
  }
}
```

--------------------------------

### Example response for GET /v1/containers

Source: https://docs.open-metadata.org/v2.0.x/api-reference/data-assets/containers/list

Example JSON response for the GET /v1/containers endpoint, showing a container object with fields like fullyQualifiedName, service, serviceType, prefix, numberOfObjects, size, fileFormats, and paging information.

```json
{
  "data": [
    {
      "id": "14744329-85c2-499e-b1fa-249fb8162341",
      "name": "analytics-bucket",
      "displayName": "Analytics Bucket",
      "fullyQualifiedName": "s3_datalake.analytics-bucket",
      "description": "Primary analytics data lake bucket",
      "version": 0.1,
      "updatedAt": 1769982673032,
      "updatedBy": "admin",
      "service": {
        "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
        "type": "storageService",
        "name": "s3_datalake",
        "fullyQualifiedName": "s3_datalake",
        "deleted": false
      },
      "serviceType": "S3",
      "prefix": "/analytics/",
      "numberOfObjects": 150000,
      "size": 5368709120,
      "fileFormats": ["parquet", "json"],
      "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
      "deleted": false,
      "owners": [],
      "tags": [],
      "followers": [],
      "votes": {
        "upVotes": 0,
        "downVotes": 0
      },
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

```

--------------------------------

### Start OpenMetadata server

Source: https://docs.open-metadata.org/v2.0.x/deployment/bare-metal

Start the OpenMetadata server. It is recommended to configure serviced to monitor this command and restart OpenMetadata in case of failures.

```bash
./bin/openmetadata.sh start

```
Tokens:
Raw