Package com.exasol.adapter

Interface VirtualSchemaAdapter

public interface VirtualSchemaAdapter

Interface for Virtual Schema Adapters.

This interface provides a number of handler functions for different types of requests a virtual schema adapter can receive from the Exasol core database.

Method Summary

Modifier and Type	Method	Description
CreateVirtualSchemaResponse	createVirtualSchema(com.exasol.ExaMetadata metadata, CreateVirtualSchemaRequest request)	Create a Virtual Schema
DropVirtualSchemaResponse	dropVirtualSchema(com.exasol.ExaMetadata metadata, DropVirtualSchemaRequest request)	Drop an existing Virtual Schema
GetCapabilitiesResponse	getCapabilities(com.exasol.ExaMetadata metadata, GetCapabilitiesRequest request)	Get the capabilities the adapter registered for a Virtual Schema supports
PushDownResponse	pushdown(com.exasol.ExaMetadata metadata, PushDownRequest request)	Create a push down request
RefreshResponse	refresh(com.exasol.ExaMetadata metadata, RefreshRequest request)	Refresh the Virtual Schema metadata for a given set of tables
SetPropertiesResponse	setProperties(com.exasol.ExaMetadata metadata, SetPropertiesRequest request)	Set Virtual Schema properties

Method Detail

createVirtualSchema

CreateVirtualSchemaResponse createVirtualSchema(com.exasol.ExaMetadata metadata,
                                                CreateVirtualSchemaRequest request)
                                         throws AdapterException

Create a Virtual Schema

Parameters:

metadata - context metadata

request - request containing the details of the Virtual Schema to be created

Returns:

response containing metadata of the created schema

Throws:

AdapterException - if the adapter can't handle the request

dropVirtualSchema

DropVirtualSchemaResponse dropVirtualSchema(com.exasol.ExaMetadata metadata,
                                            DropVirtualSchemaRequest request)
                                     throws AdapterException

Drop an existing Virtual Schema

Parameters:

metadata - context metadata

request - request containing the details of the Virtual Schema to be dropped

Returns:

drop response

Throws:

AdapterException - if the adapter can't handle the request

refresh

RefreshResponse refresh(com.exasol.ExaMetadata metadata,
                        RefreshRequest request)
                 throws AdapterException

Refresh the Virtual Schema metadata for a given set of tables

Parameters:

metadata - context metadata

request - request containing the list of tables for which the metadata should be refreshed

Returns:

response containing up-to-date metadata for the given tables

Throws:

AdapterException - if the adapter can't handle the request

setProperties

SetPropertiesResponse setProperties(com.exasol.ExaMetadata metadata,
                                    SetPropertiesRequest request)
                             throws AdapterException

Set Virtual Schema properties

Parameters:

metadata - context metadata

request - request containing the properties to be set

Returns:

property setting response

Throws:

AdapterException - if the adapter can't handle the request

getCapabilities

GetCapabilitiesResponse getCapabilities(com.exasol.ExaMetadata metadata,
                                        GetCapabilitiesRequest request)
                                 throws AdapterException

Get the capabilities the adapter registered for a Virtual Schema supports

Parameters:

metadata - context metadata

request - capabilities request

Returns:

response containing the capabilities of the adapter

Throws:

AdapterException - if the adapter can't handle the request

pushdown

PushDownResponse pushdown(com.exasol.ExaMetadata metadata,
                          PushDownRequest request)
                   throws AdapterException

Create a push down request

Parameters:

metadata - context metadata

request - request containing the SQL statement to be pushed down to the external source

Returns:

response containing the pushdown SQL statement

Throws:

AdapterException - if the adapter can't handle the request