@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/data-manager/users/{userId}")
public class DatabaseManagerResource
extends Object
| Constructor and Description |
|---|
DatabaseManagerResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
addForeignKeyRelationship(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String primaryKeyColumnGUID,
String foreignKeyColumnGUID,
DatabaseForeignKeyProperties databaseForeignKeyProperties)
Create a foreign relationship between two columns.
|
GUIDResponse |
createDatabase(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
DatabaseProperties databaseProperties)
Create a new metadata element to represent a database.
|
GUIDResponse |
createDatabaseColumn(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
DatabaseColumnProperties databaseColumnProperties)
Create a new metadata element to represent a database column.
|
GUIDResponse |
createDatabaseColumnFromTemplate(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
String databaseTableGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a database column using an existing metadata element as a template.
|
GUIDResponse |
createDatabaseFromTemplate(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a database using an existing metadata element as a template.
|
GUIDResponse |
createDatabaseSchema(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
DatabaseSchemaProperties databaseSchemaProperties)
Create a new metadata element to represent a database schema.
|
GUIDResponse |
createDatabaseSchemaFromTemplate(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
String databaseGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a database schema using an existing metadata element as a template.
|
GUIDResponse |
createDatabaseTable(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
DatabaseTableProperties databaseTableProperties)
Create a new metadata element to represent a database table.
|
GUIDResponse |
createDatabaseTableFromTemplate(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
String databaseSchemaGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a database table using an existing metadata element as a template.
|
GUIDResponse |
createDatabaseView(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
DatabaseViewProperties databaseViewProperties)
Create a new metadata element to represent a database view.
|
GUIDResponse |
createDatabaseViewFromTemplate(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String templateGUID,
String databaseSchemaGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a database view using an existing metadata element as a template.
|
DatabaseColumnsResponse |
findDatabaseColumns(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of database column metadata elements that contain the search string.
|
DatabasesResponse |
findDatabases(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of database metadata elements that contain the search string.
|
DatabaseSchemasResponse |
findDatabaseSchemas(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of database schema metadata elements that contain the search string.
|
DatabaseTablesResponse |
findDatabaseTables(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of database table metadata elements that contain the search string.
|
DatabaseViewsResponse |
findDatabaseViews(String serverName,
String userId,
String searchString,
int startFrom,
int pageSize)
Retrieve the list of database view metadata elements that contain the search string.
|
DatabaseColumnsResponse |
getColumnsForDatabaseTable(String serverName,
String userId,
String databaseTableGUID,
int startFrom,
int pageSize)
Retrieve the list of column for a database table (or view)
|
DatabaseResponse |
getDatabaseByGUID(String serverName,
String userId,
String guid)
Retrieve the database metadata element with the supplied unique identifier.
|
DatabaseColumnResponse |
getDatabaseColumnByGUID(String serverName,
String userId,
String guid)
Retrieve the database column metadata element with the supplied unique identifier.
|
DatabaseColumnsResponse |
getDatabaseColumnsByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of database column metadata elements with a matching qualified or display name.
|
DatabasesResponse |
getDatabasesByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of database metadata elements with a matching qualified or display name.
|
DatabaseSchemaResponse |
getDatabaseSchemaByGUID(String serverName,
String userId,
String guid)
Retrieve the database schema metadata element with the supplied unique identifier.
|
DatabaseSchemasResponse |
getDatabaseSchemasByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of database schema metadata elements with a matching qualified or display name.
|
DatabasesResponse |
getDatabasesForDatabaseManager(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
int startFrom,
int pageSize)
Retrieve the list of databases created by this database manager.
|
DatabaseTableResponse |
getDatabaseTableByGUID(String serverName,
String userId,
String guid)
Retrieve the database table metadata element with the supplied unique identifier.
|
DatabaseTablesResponse |
getDatabaseTablesByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of database table metadata elements with a matching qualified or display name.
|
DatabaseViewResponse |
getDatabaseViewByGUID(String serverName,
String userId,
String guid)
Retrieve the database view metadata element with the supplied unique identifier.
|
DatabaseViewsResponse |
getDatabaseViewsByName(String serverName,
String userId,
String name,
int startFrom,
int pageSize)
Retrieve the list of database view metadata elements with a matching qualified or display name.
|
DatabaseSchemasResponse |
getSchemasForDatabase(String serverName,
String userId,
String databaseGUID,
int startFrom,
int pageSize)
Return the list of schemas associated with a database.
|
DatabaseTablesResponse |
getTablesForDatabaseSchema(String serverName,
String userId,
String databaseSchemaGUID,
int startFrom,
int pageSize)
Retrieve the list of database tables associated with a database schema.
|
DatabaseViewsResponse |
getViewsForDatabaseSchema(String serverName,
String userId,
String databaseSchemaGUID,
int startFrom,
int pageSize)
Retrieve the list of database views associated with a database schema.
|
VoidResponse |
publishDatabase(String serverName,
String userId,
String databaseGUID,
NullRequestBody nullRequestBody)
Update the zones for the database asset so that it becomes visible to consumers.
|
VoidResponse |
publishDatabaseSchema(String serverName,
String userId,
String databaseSchemaGUID,
NullRequestBody nullRequestBody)
Update the zones for the database asset so that it becomes visible to consumers.
|
VoidResponse |
removeDatabase(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a database.
|
VoidResponse |
removeDatabaseColumn(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a database column.
|
VoidResponse |
removeDatabaseSchema(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a database schema.
|
VoidResponse |
removeDatabaseTable(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a database table.
|
VoidResponse |
removeDatabaseView(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseViewGUID,
String qualifiedName,
NullRequestBody nullRequestBody)
Remove the metadata element representing a database table.
|
VoidResponse |
removeForeignKeyRelationship(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String primaryKeyColumnGUID,
String foreignKeyColumnGUID,
NullRequestBody nullRequestBody)
Remove the foreign key relationship for the requested columns.
|
VoidResponse |
removePrimaryKeyFromColumn(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
NullRequestBody nullRequestBody)
Remove the classification that this column is a primary key.
|
VoidResponse |
setPrimaryKeyOnColumn(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
DatabasePrimaryKeyProperties databasePrimaryKeyProperties)
Classify a column in a database table as the primary key.
|
VoidResponse |
updateDatabase(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseGUID,
DatabaseProperties databaseProperties)
Update the metadata element representing a database.
|
VoidResponse |
updateDatabaseColumn(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseColumnGUID,
DatabaseColumnProperties databaseColumnProperties)
Update the metadata element representing a database column.
|
VoidResponse |
updateDatabaseSchema(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseSchemaGUID,
DatabaseSchemaProperties databaseSchemaProperties)
Update the metadata element representing a database schema.
|
VoidResponse |
updateDatabaseTable(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseTableGUID,
DatabaseTableProperties databaseTableProperties)
Update the metadata element representing a database table.
|
VoidResponse |
updateDatabaseView(String serverName,
String userId,
String databaseManagerGUID,
String databaseManagerName,
String databaseViewGUID,
DatabaseViewProperties databaseViewProperties)
Update the metadata element representing a database table.
|
VoidResponse |
withdrawDatabase(String serverName,
String userId,
String databaseGUID,
NullRequestBody nullRequestBody)
Update the zones for the database asset so that it is no longer visible to consumers.
|
VoidResponse |
withdrawDatabaseSchema(String serverName,
String userId,
String databaseSchemaGUID,
NullRequestBody nullRequestBody)
Update the zones for the database asset so that it is no longer visible to consumers.
|
@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases")
public GUIDResponse createDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@RequestBody
DatabaseProperties databaseProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseProperties - properties to store@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/from-template/{templateGUID}")
public GUIDResponse createDatabaseFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String templateGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMStemplateGUID - unique identifier of the metadata element to copytemplateProperties - properties that override the template@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/{databaseGUID}")
public VoidResponse updateDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseGUID,
@RequestBody
DatabaseProperties databaseProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseGUID - unique identifier of the metadata element to updatedatabaseProperties - new properties for this element@PostMapping(path="/databases/{databaseGUID}/publish")
public VoidResponse publishDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseGUID - unique identifier of the metadata element to publishnullRequestBody - empty request body@PostMapping(path="/databases/{databaseGUID}/withdraw")
public VoidResponse withdrawDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseGUID - unique identifier of the metadata element to withdrawnullRequestBody - empty request body@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/{databaseGUID}/{qualifiedName}/delete")
public VoidResponse removeDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/databases/by-search-string/{searchString}")
public DatabasesResponse findDatabases(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/by-name/{name}")
public DatabasesResponse getDatabasesByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases")
public DatabasesResponse getDatabasesForDatabaseManager(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/{guid}")
public DatabaseResponse getDatabaseByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/{databaseGUID}/schemas")
public GUIDResponse createDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseGUID,
@RequestBody
DatabaseSchemaProperties databaseSchemaProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseGUID - unique identifier of the database where the schema is locateddatabaseSchemaProperties - properties about the database schema@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/{databaseGUID}/schemas/from-template/{templateGUID}")
public GUIDResponse createDatabaseSchemaFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String templateGUID,
@PathVariable
String databaseGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMStemplateGUID - unique identifier of the metadata element to copydatabaseGUID - unique identifier of the database where the schema is locatedtemplateProperties - properties that override the template@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}")
public VoidResponse updateDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseSchemaGUID,
@RequestBody
DatabaseSchemaProperties databaseSchemaProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseSchemaGUID - unique identifier of the metadata element to updatedatabaseSchemaProperties - new properties for the metadata element@PostMapping(path="/databases/schemas/{databaseSchemaGUID}/publish")
public VoidResponse publishDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseSchemaGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseSchemaGUID - unique identifier of the metadata element to publishnullRequestBody - empty request body@PostMapping(path="/databases/schemas/{databaseSchemaGUID}/withdraw")
public VoidResponse withdrawDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseSchemaGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseSchemaGUID - unique identifier of the metadata element to withdrawnullRequestBody - empty request body@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/{qualifiedName}/delete")
public VoidResponse removeDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseSchemaGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseSchemaGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/databases/schemas/by-search-string/{searchString}")
public DatabaseSchemasResponse findDatabaseSchemas(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/{databaseGUID}/schemas")
public DatabaseSchemasResponse getSchemasForDatabase(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling userdatabaseGUID - unique identifier of the database to querystartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/by-name/{name}")
public DatabaseSchemasResponse getDatabaseSchemasByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/{guid}")
public DatabaseSchemaResponse getDatabaseSchemaByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables")
public GUIDResponse createDatabaseTable(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseSchemaGUID,
@RequestBody
DatabaseTableProperties databaseTableProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseSchemaGUID - unique identifier of the database schema where the database table is located.databaseTableProperties - properties for the database table@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables/from-template/{templateGUID}")
public GUIDResponse createDatabaseTableFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String templateGUID,
@PathVariable
String databaseSchemaGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMStemplateGUID - unique identifier of the metadata element to copydatabaseSchemaGUID - unique identifier of the database schema where the database table is located.templateProperties - properties that override the template@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables/{databaseTableGUID}")
public VoidResponse updateDatabaseTable(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseTableGUID,
@RequestBody
DatabaseTableProperties databaseTableProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseTableGUID - unique identifier of the database table to updatedatabaseTableProperties - new properties for the database table@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables/{databaseTableGUID}/{qualifiedName}/delete")
public VoidResponse removeDatabaseTable(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseTableGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseTableGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/databases/schemas/tables/by-search-string/{searchString}")
public DatabaseTablesResponse findDatabaseTables(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/{databaseSchemaGUID}/tables")
public DatabaseTablesResponse getTablesForDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseSchemaGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling userdatabaseSchemaGUID - unique identifier of the database schema of intereststartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/by-name/{name}")
public DatabaseTablesResponse getDatabaseTablesByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/{guid}")
public DatabaseTableResponse getDatabaseTableByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables/views")
public GUIDResponse createDatabaseView(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseSchemaGUID,
@RequestBody
DatabaseViewProperties databaseViewProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseSchemaGUID - unique identifier of the database schema where the database view is located.databaseViewProperties - properties for the new view@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/{databaseSchemaGUID}/tables/views/from-template/{templateGUID}")
public GUIDResponse createDatabaseViewFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String templateGUID,
@PathVariable
String databaseSchemaGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMStemplateGUID - unique identifier of the metadata element to copydatabaseSchemaGUID - unique identifier of the database schema where the database view is located.templateProperties - properties that override the template@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/views/{databaseViewGUID}")
public VoidResponse updateDatabaseView(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseViewGUID,
@RequestBody
DatabaseViewProperties databaseViewProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseViewGUID - unique identifier of the database view to updatedatabaseViewProperties - properties for the new database view@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/views/{databaseViewGUID}/{qualifiedName}/delete")
public VoidResponse removeDatabaseView(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseViewGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseViewGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/databases/schemas/tables/views/by-search-string/{searchString}")
public DatabaseViewsResponse findDatabaseViews(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/{databaseSchemaGUID}/tables/views")
public DatabaseViewsResponse getViewsForDatabaseSchema(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseSchemaGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling userdatabaseSchemaGUID - unique identifier of the database schema of intereststartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/views/by-name/{name}")
public DatabaseViewsResponse getDatabaseViewsByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/views/{guid}")
public DatabaseViewResponse getDatabaseViewByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/{databaseTableGUID}/columns")
public GUIDResponse createDatabaseColumn(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseTableGUID,
@RequestBody
DatabaseColumnProperties databaseColumnProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseTableGUID - unique identifier of the database table where this column is locateddatabaseColumnProperties - properties for the new column@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/{databaseTableGUID}/columns/from-template/{templateGUID}")
public GUIDResponse createDatabaseColumnFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String templateGUID,
@PathVariable
String databaseTableGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMStemplateGUID - unique identifier of the metadata element to copydatabaseTableGUID - unique identifier of the database table where this column is locatedtemplateProperties - properties that override the template@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{databaseColumnGUID}")
public VoidResponse updateDatabaseColumn(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseColumnGUID,
@RequestBody
DatabaseColumnProperties databaseColumnProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseColumnGUID - unique identifier of the metadata element to updatedatabaseColumnProperties - new properties for the metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{databaseColumnGUID}/{qualifiedName}/delete")
public VoidResponse removeDatabaseColumn(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseColumnGUID,
@PathVariable
String qualifiedName,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseColumnGUID - unique identifier of the metadata element to removequalifiedName - unique name of the metadata element to removenullRequestBody - empty request body@GetMapping(path="/databases/schemas/tables/columns/by-search-string/{searchString}")
public DatabaseColumnsResponse findDatabaseColumns(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String searchString,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling usersearchString - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/{databaseTableGUID}/columns")
public DatabaseColumnsResponse getColumnsForDatabaseTable(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseTableGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling userdatabaseTableGUID - unique identifier of the database table of intereststartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/columns/by-name/{name}")
public DatabaseColumnsResponse getDatabaseColumnsByName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String name,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request to.userId - calling username - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/databases/schemas/tables/columns/{guid}")
public DatabaseColumnResponse getDatabaseColumnByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String guid)
serverName - name of the service to route the request to.userId - calling userguid - unique identifier of the requested metadata element@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{databaseColumnGUID}/primary-key")
public VoidResponse setPrimaryKeyOnColumn(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseColumnGUID,
@RequestBody
DatabasePrimaryKeyProperties databasePrimaryKeyProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseColumnGUID - unique identifier if the primary key columndatabasePrimaryKeyProperties - properties to store@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{databaseColumnGUID}/primary-key/delete")
public VoidResponse removePrimaryKeyFromColumn(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String databaseColumnGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSdatabaseColumnGUID - unique identifier if the primary key columnnullRequestBody - empty request body@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{foreignKeyColumnGUID}/foreign-key/{primaryKeyColumnGUID}")
public VoidResponse addForeignKeyRelationship(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String primaryKeyColumnGUID,
@PathVariable
String foreignKeyColumnGUID,
@RequestBody
DatabaseForeignKeyProperties databaseForeignKeyProperties)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSprimaryKeyColumnGUID - unique identifier of the column containing the primary keyforeignKeyColumnGUID - unique identifier of the column containing the primary key from the other tabledatabaseForeignKeyProperties - properties about the foreign key relationship@PostMapping(path="/database-managers/{databaseManagerGUID}/{databaseManagerName}/databases/schemas/tables/columns/{foreignKeyColumnGUID}/foreign-key/{primaryKeyColumnGUID}/delete")
public VoidResponse removeForeignKeyRelationship(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String databaseManagerGUID,
@PathVariable
String databaseManagerName,
@PathVariable
String primaryKeyColumnGUID,
@PathVariable
String foreignKeyColumnGUID,
@RequestBody(required=false)
NullRequestBody nullRequestBody)
serverName - name of the service to route the request to.userId - calling userdatabaseManagerGUID - unique identifier of software server capability representing the owning DBMSdatabaseManagerName - unique name of software server capability representing the owning DBMSprimaryKeyColumnGUID - unique identifier of the column that is the linked primary keyforeignKeyColumnGUID - unique identifier of the column the contains the primary key from another tablenullRequestBody - empty request bodyCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.