Package org.odpi.openmetadata.accessservices.analyticsmodeling.api

Interface AnalyticsModelingImport

public interface AnalyticsModelingImport

Method Summary

Modifier and Type	Method	Description
List<ResponseContainerDatabase>	getDatabases(String userId, int startFrom, int pageSize)	Get databases available on the server for the user.
ResponseContainerModule	getModule(String userId, String databaseGuid, String catalog, String schema, ModuleTableFilter request)	Build module for the schema.
List<ResponseContainerDatabaseSchema>	getSchemas(String userId, String databaseGuid, int startFrom, int pageSize)	Get schema defined by database GUID.
ResponseContainerSchemaTables	getTables(String userId, String databaseGuid, String catalog, String schema)	Get tables for the schema.

Method Detail

getDatabases

List<ResponseContainerDatabase> getDatabases(String userId,
                                             int startFrom,
                                             int pageSize)
                                      throws AnalyticsModelingCheckedException,
                                             PropertyServerException,
                                             InvalidParameterException,
                                             UserNotAuthorizedException

Get databases available on the server for the user.

Parameters:

userId - of the user.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of databases for the requested server/user.

Throws:

AnalyticsModelingCheckedException - error executing request.

PropertyServerException - in case REST call failed.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.

getSchemas

List<ResponseContainerDatabaseSchema> getSchemas(String userId,
                                                 String databaseGuid,
                                                 int startFrom,
                                                 int pageSize)
                                          throws AnalyticsModelingCheckedException,
                                                 PropertyServerException,
                                                 InvalidParameterException,
                                                 UserNotAuthorizedException

Get schema defined by database GUID.

Parameters:

userId - of the request.

databaseGuid - of the requested database.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of schemas for the requested database.

Throws:

AnalyticsModelingCheckedException - error executing request.

PropertyServerException - in case REST call failed.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.

getTables

ResponseContainerSchemaTables getTables(String userId,
                                        String databaseGuid,
                                        String catalog,
                                        String schema)
                                 throws AnalyticsModelingCheckedException,
                                        PropertyServerException,
                                        InvalidParameterException,
                                        UserNotAuthorizedException

Get tables for the schema.

Parameters:

userId - of the request.

databaseGuid - of the requested database.

catalog - catalog name of the database.

schema - schema name on the database.

Returns:

list of tables for the requested schema.

Throws:

AnalyticsModelingCheckedException - error executing request.

PropertyServerException - in case REST call failed.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.

getModule

ResponseContainerModule getModule(String userId,
                                  String databaseGuid,
                                  String catalog,
                                  String schema,
                                  ModuleTableFilter request)
                           throws AnalyticsModelingCheckedException,
                                  PropertyServerException,
                                  InvalidParameterException,
                                  UserNotAuthorizedException

Build module for the schema.

Parameters:

userId - of the request.

databaseGuid - of the requested database.

catalog - catalog name of the database.

schema - schema name of the database.

request - table filter

Returns:

module for the requested schema.

Throws:

AnalyticsModelingCheckedException - error executing request.

PropertyServerException - in case REST call failed.

UserNotAuthorizedException - in case user unauthorized to perform operation.

InvalidParameterException - in case any passed parameter is invalid.