Package org.openmetadata.service.resources.databases

Class DatabaseResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Database,DatabaseRepository>

org.openmetadata.service.resources.databases.DatabaseResource

@Path("/v1/databases")
@Produces("application/json")
@Consumes("application/json")
public class DatabaseResource
extends EntityResource<Database,DatabaseRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseResource.DatabaseList

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
DatabaseResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Database	addDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid DatabaseProfilerConfig databaseProfilerConfig)
Database	addHref(javax.ws.rs.core.UriInfo uriInfo, Database db)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDatabase create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDatabase create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
Database	deleteDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
@Valid String	exportCsv(javax.ws.rs.core.SecurityContext securityContext, String name)
Database	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Database	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Database	getDataProfilerConfig(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
protected List<MetadataOperation>	getEntitySpecificOperations()
Database	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
@Valid CsvImportResult	importCsv(javax.ws.rs.core.SecurityContext securityContext, String name, boolean dryRun, String csv)
ResultList<Database>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String serviceParam, @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	restoreDatabase(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	updateVote(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid VoteRequest request)

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

addHref, addViewOperation, 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 Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

Constructor Details

DatabaseResource

public DatabaseResource(Authorizer authorizer)

Method Details

addHref

public Database addHref(javax.ws.rs.core.UriInfo uriInfo,
 Database db)

Overrides:

addHref in class EntityResource<Database,DatabaseRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Database,DatabaseRepository>

list

@GET
public ResultList<Database> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("service")
 String serviceParam,
 @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 Database 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 Database 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 Database 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 CreateDatabase 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 CreateDatabase 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)

exportCsv

@GET
@Path("/name/{name}/export")
@Produces("text/plain")
@Valid
public @Valid String exportCsv(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name)
                        throws IOException

Throws:

IOException

importCsv

@PUT
@Path("/name/{name}/import")
@Consumes("text/plain")
@Valid
public @Valid CsvImportResult importCsv(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name,
 @DefaultValue("true") @QueryParam("dryRun")
 boolean dryRun,
 String csv)
                                 throws IOException

Throws:

IOException

updateVote

@PUT
@Path("/{id}/vote")
public javax.ws.rs.core.Response updateVote(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid VoteRequest request)

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,
 @QueryParam("recursive") @DefaultValue("false")
 boolean recursive,
 @PathParam("fqn")
 String fqn)

restoreDatabase

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

addDataProfilerConfig

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

getDataProfilerConfig

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

deleteDataProfilerConfig

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