Package org.openmetadata.service.resources.databases

Class TableResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Table,TableRepository>

org.openmetadata.service.resources.databases.TableResource

@Path("/v1/tables")
@Produces("application/json")
@Consumes("application/json")
public class TableResource
extends EntityResource<Table,TableRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableResource.ColumnProfileList
static class	TableResource.SystemProfileList
static class	TableResource.TableList
static class	TableResource.TableProfileList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
TableResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Table	addCustomMetric(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid CreateCustomMetric createCustomMetric)
Table	addDataModel(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid DataModel dataModel)
Table	addDataProfiler(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid CreateTableProfile createTableProfile)
Table	addDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TableProfilerConfig tableProfilerConfig)
javax.ws.rs.core.Response	addFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID userId)
Table	addHref(javax.ws.rs.core.UriInfo uriInfo, Table table)
Table	addJoins(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TableJoins joins)
Table	addSampleData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TableData tableData)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTable create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTable create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, UUID id)
javax.ws.rs.core.Response	deleteByFqn(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
Table	deleteCustomMetric(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String columnName, String customMetricName)
javax.ws.rs.core.Response	deleteDataProfiler(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, String entityType, Long timestamp)
Table	deleteDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	deleteFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String userId)
Table	deleteSampleData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
Table	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Table	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, String fieldsParam, Include include)
Table	getDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
protected List<MetadataOperation>	getEntitySpecificOperations()
javax.ws.rs.core.Response	getLatestTableProfile(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn)
Table	getSampleData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
Table	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<Table>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String databaseParam, String databaseSchemaParam, boolean includeEmptyTestSuite, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
ResultList<ColumnProfile>	listColumnProfiles(javax.ws.rs.core.SecurityContext securityContext, String fqn, @NotNull Long startTs, @NotNull Long endTs)
ResultList<SystemProfile>	listSystemProfiles(javax.ws.rs.core.SecurityContext securityContext, String fqn, @NotNull Long startTs, @NotNull Long endTs)
javax.ws.rs.core.Response	listTableProfiles(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, Long startTs, Long endTs)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreTable(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
static Table	validateNewTable(Table table)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addViewOperation, copy, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, initialize, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

TableResource

public TableResource(CollectionDAO dao,
                     Authorizer authorizer)

Method Detail

addHref

public Table addHref(javax.ws.rs.core.UriInfo uriInfo,
                     Table table)

Specified by:

addHref in class EntityResource<Table,TableRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Table,TableRepository>

list

@GET
public ResultList<Table> list(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              javax.ws.rs.core.SecurityContext securityContext,
                              @QueryParam("fields")
                              String fieldsParam,
                              @QueryParam("database")
                              String databaseParam,
                              @QueryParam("databaseSchema")
                              String databaseSchemaParam,
                              @QueryParam("includeEmptyTestSuite") @DefaultValue("true")
                              boolean includeEmptyTestSuite,
                              @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
                              @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
                              @QueryParam("before")
                              String before,
                              @QueryParam("after")
                              String after,
                              @QueryParam("include") @DefaultValue("non-deleted")
                              Include include)

get

@GET
@Path("/{id}")
public Table get(@Context
                 javax.ws.rs.core.UriInfo uriInfo,
                 @Context
                 javax.ws.rs.core.SecurityContext securityContext,
                 @PathParam("id")
                 UUID id,
                 @QueryParam("fields")
                 String fieldsParam,
                 @QueryParam("include") @DefaultValue("non-deleted")
                 Include include)

getByName

@GET
@Path("/name/{fqn}")
public Table getByName(@Context
                       javax.ws.rs.core.UriInfo uriInfo,
                       @Context
                       javax.ws.rs.core.SecurityContext securityContext,
                       @PathParam("fqn")
                       String fqn,
                       @QueryParam("fields")
                       String fieldsParam,
                       @QueryParam("include") @DefaultValue("non-deleted")
                       Include include)

listVersions

@GET
@Path("/{id}/versions")
public EntityHistory listVersions(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @Context
                                  javax.ws.rs.core.SecurityContext securityContext,
                                  @PathParam("id")
                                  UUID id)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Table getVersion(@Context
                        javax.ws.rs.core.UriInfo uriInfo,
                        @Context
                        javax.ws.rs.core.SecurityContext securityContext,
                        @PathParam("id")
                        UUID id,
                        @PathParam("version")
                        String version)

create

@POST
public javax.ws.rs.core.Response create(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @Valid
                                        @Valid CreateTable create)

createOrUpdate

@PUT
public javax.ws.rs.core.Response createOrUpdate(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @Valid
                                                @Valid CreateTable create)

patch

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patch(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.ws.rs.core.SecurityContext securityContext,
                                       @PathParam("id")
                                       UUID id,
                                       javax.json.JsonPatch patch)

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @QueryParam("hardDelete") @DefaultValue("false")
                                        boolean hardDelete,
                                        @QueryParam("recursive") @DefaultValue("false")
                                        boolean recursive,
                                        @PathParam("id")
                                        UUID id)

deleteByFqn

@DELETE
@Path("/name/{fqn}")
public javax.ws.rs.core.Response deleteByFqn(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @QueryParam("hardDelete") @DefaultValue("false")
                                             boolean hardDelete,
                                             @PathParam("fqn")
                                             String fqn)

restoreTable

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restoreTable(@Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              @Context
                                              javax.ws.rs.core.SecurityContext securityContext,
                                              @Valid
                                              @Valid RestoreEntity restore)

addFollower

@PUT
@Path("/{id}/followers")
public javax.ws.rs.core.Response addFollower(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @PathParam("id")
                                             UUID id,
                                             UUID userId)

addJoins

@PUT
@Path("/{id}/joins")
public Table addJoins(@Context
                      javax.ws.rs.core.UriInfo uriInfo,
                      @Context
                      javax.ws.rs.core.SecurityContext securityContext,
                      @PathParam("id")
                      UUID id,
                      @Valid
                      @Valid TableJoins joins)

addSampleData

@PUT
@Path("/{id}/sampleData")
public Table addSampleData(@Context
                           javax.ws.rs.core.UriInfo uriInfo,
                           @Context
                           javax.ws.rs.core.SecurityContext securityContext,
                           @PathParam("id")
                           UUID id,
                           @Valid
                           @Valid TableData tableData)

getSampleData

@GET
@Path("/{id}/sampleData")
public Table getSampleData(@Context
                           javax.ws.rs.core.UriInfo uriInfo,
                           @Context
                           javax.ws.rs.core.SecurityContext securityContext,
                           @PathParam("id")
                           UUID id)

deleteSampleData

@DELETE
@Path("/{id}/sampleData")
public Table deleteSampleData(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              javax.ws.rs.core.SecurityContext securityContext,
                              @PathParam("id")
                              UUID id)

addDataProfilerConfig

@PUT
@Path("/{id}/tableProfilerConfig")
public Table addDataProfilerConfig(@Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.ws.rs.core.SecurityContext securityContext,
                                   @PathParam("id")
                                   UUID id,
                                   @Valid
                                   @Valid TableProfilerConfig tableProfilerConfig)

getDataProfilerConfig

@GET
@Path("/{id}/tableProfilerConfig")
public Table getDataProfilerConfig(@Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.ws.rs.core.SecurityContext securityContext,
                                   @PathParam("id")
                                   UUID id)

deleteDataProfilerConfig

@DELETE
@Path("/{id}/tableProfilerConfig")
public Table deleteDataProfilerConfig(@Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      @Context
                                      javax.ws.rs.core.SecurityContext securityContext,
                                      @PathParam("id")
                                      UUID id)

getLatestTableProfile

@GET
@Path("/{fqn}/tableProfile/latest")
public javax.ws.rs.core.Response getLatestTableProfile(@Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       @Context
                                                       javax.ws.rs.core.SecurityContext securityContext,
                                                       @PathParam("fqn")
                                                       String fqn)

listTableProfiles

@GET
@Path("/{fqn}/tableProfile")
public javax.ws.rs.core.Response listTableProfiles(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                   @PathParam("fqn")
                                                   String fqn,
                                                   @QueryParam("startTs")
                                                   Long startTs,
                                                   @QueryParam("endTs")
                                                   Long endTs)

listColumnProfiles

@GET
@Path("/{fqn}/columnProfile")
public ResultList<ColumnProfile> listColumnProfiles(@Context
                                                    javax.ws.rs.core.SecurityContext securityContext,
                                                    @PathParam("fqn")
                                                    String fqn,
                                                    @NotNull @QueryParam("startTs")
                                                    @NotNull Long startTs,
                                                    @NotNull @QueryParam("endTs")
                                                    @NotNull Long endTs)

listSystemProfiles

@GET
@Path("/{fqn}/systemProfile")
public ResultList<SystemProfile> listSystemProfiles(@Context
                                                    javax.ws.rs.core.SecurityContext securityContext,
                                                    @PathParam("fqn")
                                                    String fqn,
                                                    @NotNull @QueryParam("startTs")
                                                    @NotNull Long startTs,
                                                    @NotNull @QueryParam("endTs")
                                                    @NotNull Long endTs)

addDataProfiler

@PUT
@Path("/{id}/tableProfile")
public Table addDataProfiler(@Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             @Context
                             javax.ws.rs.core.SecurityContext securityContext,
                             @PathParam("id")
                             UUID id,
                             @Valid
                             @Valid CreateTableProfile createTableProfile)

deleteDataProfiler

@DELETE
@Path("/{fqn}/{entityType}/{timestamp}/profile")
public javax.ws.rs.core.Response deleteDataProfiler(@Context
                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                    @Context
                                                    javax.ws.rs.core.SecurityContext securityContext,
                                                    @PathParam("fqn")
                                                    String fqn,
                                                    @PathParam("entityType")
                                                    String entityType,
                                                    @PathParam("timestamp")
                                                    Long timestamp)

addDataModel

@PUT
@Path("/{id}/dataModel")
public Table addDataModel(@Context
                          javax.ws.rs.core.UriInfo uriInfo,
                          @Context
                          javax.ws.rs.core.SecurityContext securityContext,
                          @PathParam("id")
                          UUID id,
                          @Valid
                          @Valid DataModel dataModel)

addCustomMetric

@PUT
@Path("/{id}/customMetric")
public Table addCustomMetric(@Context
                             javax.ws.rs.core.UriInfo uriInfo,
                             @Context
                             javax.ws.rs.core.SecurityContext securityContext,
                             @PathParam("id")
                             UUID id,
                             @Valid
                             @Valid CreateCustomMetric createCustomMetric)

deleteCustomMetric

@DELETE
@Path("/{id}/customMetric/{columnName}/{customMetricName}")
public Table deleteCustomMetric(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                javax.ws.rs.core.SecurityContext securityContext,
                                @PathParam("id")
                                UUID id,
                                @PathParam("columnName")
                                String columnName,
                                @PathParam("customMetricName")
                                String customMetricName)

deleteFollower

@DELETE
@Path("/{id}/followers/{userId}")
public javax.ws.rs.core.Response deleteFollower(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @PathParam("id")
                                                UUID id,
                                                @PathParam("userId")
                                                String userId)

validateNewTable

public static Table validateNewTable(Table table)