Package org.openmetadata.service.resources.databases

Class DatabaseSchemaResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<DatabaseSchema,DatabaseSchemaRepository>

org.openmetadata.service.resources.databases.DatabaseSchemaResource

@Path("/v1/databaseSchemas")
@Produces("application/json")
@Consumes("application/json")
public class DatabaseSchemaResource
extends EntityResource<DatabaseSchema,DatabaseSchemaRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseSchemaResource.DatabaseSchemaList

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
DatabaseSchemaResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
DatabaseSchema	addHref(javax.ws.rs.core.UriInfo uriInfo, DatabaseSchema schema)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDatabaseSchema create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDatabaseSchema create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
DatabaseSchema	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
DatabaseSchema	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
DatabaseSchema	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<DatabaseSchema>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String databaseParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
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	restoreDatabaseSchema(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)

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

DatabaseSchemaResource

public DatabaseSchemaResource(CollectionDAO dao,
                              Authorizer authorizer)

Method Detail

addHref

public DatabaseSchema addHref(javax.ws.rs.core.UriInfo uriInfo,
                              DatabaseSchema schema)

Specified by:

addHref in class EntityResource<DatabaseSchema,DatabaseSchemaRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<DatabaseSchema,DatabaseSchemaRepository>

list

@GET
public ResultList<DatabaseSchema> list(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.ws.rs.core.SecurityContext securityContext,
                                       @QueryParam("fields")
                                       String fieldsParam,
                                       @QueryParam("database")
                                       String databaseParam,
                                       @DefaultValue("10") @QueryParam("limit") @Min(0L) @Max(1000000L)
                                       @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)

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)

get

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

getByName

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

getVersion

@GET
@Path("/{id}/versions/{version}")
public DatabaseSchema 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 CreateDatabaseSchema 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)

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 CreateDatabaseSchema create)

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,
                                        @DefaultValue("false") @QueryParam("recursive")
                                        boolean recursive,
                                        @QueryParam("hardDelete") @DefaultValue("false")
                                        boolean hardDelete,
                                        @PathParam("id")
                                        UUID id)

delete

@DELETE
@Path("/name/{fqn}")
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,
                                        @PathParam("fqn")
                                        String fqn)

restoreDatabaseSchema

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