Package com.exasol.adapter

Interface AdapterFactory

All Superinterfaces:

AutoCloseable

public interface AdapterFactory
extends AutoCloseable

Factory that creates a VirtualSchemaAdapter

Method Summary

Modifier and Type	Method	Description
default void	close()
VirtualSchemaAdapter	createAdapter(AdapterContext context)	Create a new VirtualSchemaAdapter
String	getAdapterName()	Get the name of the VirtualSchemaAdapter.
String	getAdapterProjectShortTag()	Get a short tag for the adapter project.
String	getAdapterVersion()	Get the version of the VirtualSchemaAdapter.

Method Detail

createAdapter

VirtualSchemaAdapter createAdapter(AdapterContext context)

Create a new VirtualSchemaAdapter

Parameters:

context - context information for the adapter

Returns:

new instance

getAdapterVersion

String getAdapterVersion()

Get the version of the VirtualSchemaAdapter. This version will be used for logging and telemetry.

Adapters can use VersionCollector to fetch the version from the metadata in the jar file. For example:

 new VersionCollector("META-INF/maven/com.exasol/mysql-virtual-schema/pom.properties").getVersionNumber()
 

Returns:

Virtual Schema Adapter version

getAdapterName

String getAdapterName()

Get the name of the VirtualSchemaAdapter. This name will be used for logging.

Example values:

• JDBC based adapters: MYSQL JDBC Adapter, POSTGRESQL JDBC Adapter, EXASOL JDBC Adapter
• Document based adapters: DYNAMO_DB, S3_DOCUMENT_FILES, AZURE_DATA_LAKE_STORAGE_GEN2_DOCUMENT_FILES

Returns:

Virtual Schema Adapter name

getAdapterProjectShortTag

String getAdapterProjectShortTag()

Get a short tag for the adapter project. This will be used for telemetry to identify products.

The short tag is defined in file error_code_config.yml of each adapter project.

Example values: VSMYSQL, VSPG (Postgres VS), VSEXA, VSDY (DynamoDB VS), VSS3, VSADLG2

Returns:

short tag for the adapter project

close

default void close()

Specified by:

close in interface AutoCloseable