io.cdap.wrangler.service.database

Class DatabaseHandler

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<V>

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

io.cdap.wrangler.service.common.AbstractWranglerHandler

io.cdap.wrangler.service.database.DatabaseHandler

All Implemented Interfaces:

io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>, io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

public class DatabaseHandler
extends AbstractWranglerHandler

Class description here.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DatabaseHandler.Executor Executes something using a SQL connection.

Nested classes/interfaces inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

AbstractWranglerHandler.NamespacedResponder<T>

Constructor Summary

Constructors

Constructor and Description
DatabaseHandler()

Method Summary

Modifier and Type	Method and Description
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
void	listAvailableDrivers(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) List all the possible drivers supported.
void	listDatabases(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Lists all databases.
void	listDrivers(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Lists all the JDBC drivers installed.
void	listTables(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id) Lists all the tables within a database.
void	read(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, String table, int lines, String scope) Reads a table into workspace.
void	specification(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, String table) Specification for the source.
void	testConnection(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace)

Methods inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, respond, respond, shouldCopyHeader

Methods inherited from class io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

createTable

Methods inherited from class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, destroy, getConfigurer, getContext, setProperties

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseHandler

public DatabaseHandler()

Method Detail

initialize

public void initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
                throws Exception

Specified by:

initialize in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

initialize in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

initialize in class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Throws:

Exception

listDrivers

@GET
 @Path(value="contexts/{context}/jdbc/drivers")
public void listDrivers(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                             io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                             @PathParam(value="context")
                                                                             String namespace)

Lists all the JDBC drivers installed.

Following is JSON Response { "count": 1, "message": "Success", "status": 200, "values": [ { "label": "MySQL", "version": "5.1.39" "url": "jdbc:mysql://${hostname}:${port}/${database}?user=${username}&password=${password}" "default.port" : "3306", "properties": { "class": "com.mysql.jdbc.Driver", "name": "mysql", "type": "jdbc", }, "required" : [ "hostname", "port", "database", "username", "password", "url" ] } ] }

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

listAvailableDrivers

@GET
 @Path(value="contexts/{context}/jdbc/allowed")
public void listAvailableDrivers(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                      io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                      @PathParam(value="context")
                                                                                      String namespace)

List all the possible drivers supported. Following is the sample response { "status" : 200, "message" : "Success", "count" : 1, "values" : [ { "class" : "com.jdbc.sql.Driver", "label" : "mysql", "name" : "mysql" } ] } TODO: figure out why this and the listDrivers() method both exist and why they have different response fields

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

testConnection

@POST
 @Path(value="contexts/{context}/connections/jdbc/test")
public void testConnection(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                          io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                          @PathParam(value="context")
                                                                                          String namespace)

listDatabases

@POST
 @Path(value="contexts/{context}/connections/databases")
public void listDatabases(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                         io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                         @PathParam(value="context")
                                                                                         String namespace)

Lists all databases.

Parameters:

request - HTTP requests handler.

responder - HTTP response handler.

listTables

@GET
 @Path(value="contexts/{context}/connections/{id}/tables")
public void listTables(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                       io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                       @PathParam(value="context")
                                                                                       String namespace,
                                                                                       @PathParam(value="id")
                                                                                       String id)

Lists all the tables within a database.

Parameters:

request - HTTP requests handler.

responder - HTTP response handler.

id - Connection id for which the tables need to be listed from database.

read

@GET
 @Path(value="contexts/{context}/connections/{id}/tables/{table}/read")
public void read(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                              io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                              @PathParam(value="context")
                                                                                              String namespace,
                                                                                              @PathParam(value="id")
                                                                                              String id,
                                                                                              @PathParam(value="table")
                                                                                              String table,
                                                                                              @QueryParam(value="lines")
                                                                                              int lines,
                                                                                              @QueryParam(value="scope") @DefaultValue(value="default")
                                                                                              String scope)

Reads a table into workspace.

Parameters:

request - HTTP requests handler.

responder - HTTP response handler.

id - Connection id for which the tables need to be listed from database.

table - Name of the database table.

lines - No of lines to be read from RDBMS table.

scope - Group the workspace should be created in.

specification

@GET
 @Path(value="contexts/{context}/connections/{id}/tables/{table}/specification")
public void specification(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                                                io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                                                @PathParam(value="context")
                                                                                                                String namespace,
                                                                                                                @PathParam(value="id")
                                                                                                                String id,
                                                                                                                @PathParam(value="table")
                                                                                                                String table)

Specification for the source.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.

id - of the connection.

table - in the database.