Skip to main content

​
Tables

A Table is the most feature-rich entity in OpenMetadata. It belongs to a DatabaseSchema and represents a structured dataset with columns, profiles, sample data, lineage, and more.
Entity schema follows the OpenMetadata Standard.

​
Entity Hierarchy

Tables sit at the bottom of the database hierarchy: 
DatabaseService
└── Database
    └── DatabaseSchema
        └── Table (this page)

​
FQN Format

A table’s fully qualified name follows the pattern: 
service.database.schema.table
For example: snowflake_prod.analytics.public.customers

​
SDK References

  • Python: from metadata.sdk.entities import Table
  • Java: org.openmetadata.sdk.entities.Tables / org.openmetadata.sdk.fluent.Tables

​
API Endpoints

​
CRUD Operations

MethodEndpointDescription
PUT/v1/tablesCreate or update a table
POST/v1/tablesCreate a table (POST variant)
GET/v1/tablesList tables
GET/v1/tables/{id}Get by ID
GET/v1/tables/name/{fqn}Get by FQN
PATCH/v1/tables/{id}Update by ID
PATCH/v1/tables/name/{fqn}Update by name
DELETE/v1/tables/{id}Delete by ID
DELETE/v1/tables/name/{fqn}Delete by name
PUT/v1/tables/restoreRestore soft-deleted table

​
Versions

MethodEndpointDescription
GET/v1/tables/{id}/versionsList versions
GET/v1/tables/{id}/versions/{version}Get specific version

​
Import / Export

MethodEndpointDescription
GET/v1/tables/name/{fqn}/exportExport to CSV
GET/v1/tables/name/{fqn}/exportAsyncExport to CSV (async)
PUT/v1/tables/name/{fqn}/importImport from CSV
PUT/v1/tables/name/{fqn}/importAsyncImport from CSV (async)

​
Sample Data

MethodEndpointDescription
GET/v1/tables/{id}/sampleDataGet sample data
PUT/v1/tables/{id}/sampleDataAdd sample data
DELETE/v1/tables/{id}/sampleDataDelete sample data

​
Profiler & Profile Data

MethodEndpointDescription
GET/v1/tables/{id}/profilerConfigGet profiler config
PUT/v1/tables/{id}/profilerConfigSet profiler config
DELETE/v1/tables/{id}/profilerConfigDelete profiler config
GET/v1/tables/{id}/tableProfileGet table profile
GET/v1/tables/{id}/columnProfileGet column profile
GET/v1/tables/{id}/systemProfileGet system profile

​
Pipeline Observability

MethodEndpointDescription
GET/v1/tables/{id}/pipelineObservabilityGet observability data
PUT/v1/tables/{id}/pipelineObservabilityAdd observability data

​
Relationships & Data Model

MethodEndpointDescription
PUT/v1/tables/{id}/joinsAdd join info
PUT/v1/tables/{id}/dataModelSet data model
GET/v1/tables/{id}/columnsGet columns

​
Custom Metrics

MethodEndpointDescription
PUT/v1/tables/{id}/customMetricAdd custom metric
DELETE/v1/tables/{id}/customMetric/{metricName}Delete custom metric

​
Followers & Votes

MethodEndpointDescription
PUT/v1/tables/{id}/followersAdd follower
DELETE/v1/tables/{id}/followers/{userId}Remove follower
PUT/v1/tables/{id}/voteAdd/update vote

​
Query & Usage

MethodEndpointDescription
GET/v1/tables/{id}/tableQueryGet table queries
PUT/v1/tables/{id}/tableQueryAdd table query
GET/v1/tables/{id}/usageSummaryGet usage summary

​
Tests

MethodEndpointDescription
GET/v1/tables/{id}/testSuiteGet test suite
PUT/v1/tables/{id}/testSuiteAdd test suite
DELETE/v1/tables/{id}/testSuiteDelete test suite

​
Lineage

MethodEndpointDescription
GET/v1/tables/{id}/lineageGet lineage
PUT/v1/tables/{id}/lineageAdd lineage edge
DELETE/v1/tables/{id}/lineageDelete lineage edge

​
Entity Relationships

MethodEndpointDescription
GET/v1/tables/{id}/relationshipsGet entity relationships
PUT/v1/tables/{id}/relationshipsAdd entity relationship
DELETE/v1/tables/{id}/relationships/{relId}Delete entity relationship