ru.yandex.clickhouse.jdbcbridge.core

Class NamedDataSource

java.lang.Object

ru.yandex.clickhouse.jdbcbridge.core.ManagedEntity

ru.yandex.clickhouse.jdbcbridge.core.NamedDataSource

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ConfigDataSource, JdbcDataSource, ScriptDataSource

public class NamedDataSource
extends ManagedEntity
implements Closeable

This class defines a named datasource. It's the base class of all other types of datasources.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CACHE_STAT_EVICTION_COUNT
protected static String	CACHE_STAT_EVICTION_WEIGHT
protected static String	CACHE_STAT_HIT_COUNT
protected static String	CACHE_STAT_LOAD_FAILURE_COUNT
protected static String	CACHE_STAT_LOAD_SUCCESS_COUNT
protected static String	CACHE_STAT_MISS_COUNT
protected static String	CACHE_STAT_TOTAL_LOAD_TIME
protected static String	COLUMN_PREFIX
protected static String	CONF_CACHE
static String	CONF_CLASS
protected static String	CONF_COLUMNS
static String	CONF_CONVERTER
protected static String	CONF_DEFAULTS
protected static String	CONF_DRIVER_URLS
protected static String	CONF_EXPIRATION
static String	CONF_JDBC_TYPE
static String	CONF_JDBC_URL
static String	CONF_MAPPINGS
static String	CONF_NATIVE_TYPE
protected static String	CONF_PARAMETERS
static String	CONF_QUERY_TIMEOUT
static String	CONF_SCHEMA
static String	CONF_SEALED
protected static String	CONF_SIZE
static String	CONF_TIMEZONE
static String	CONF_TO_TYPE
static String	CONF_TYPE
static String	CONF_WRITE_TIMEOUT
protected DataTypeConverter	converter
static String	DEFAULT_QUOTE_IDENTIFIER
protected static String	EMPTY_USAGE
protected static boolean	USE_CUSTOM_DRIVER_LOADER

Fields inherited from class ru.yandex.clickhouse.jdbcbridge.core.ManagedEntity

aliases, CONF_ALIASES, CONF_ID, createDateTime, digest, id, type

Constructor Summary

Constructors

Constructor and Description
NamedDataSource(String id, Repository<? extends NamedDataSource> repository, io.vertx.core.json.JsonObject config)

Method Summary

Modifier and Type	Method and Description
void	close()
void	executeMutation(String schema, String target, TableDefinition columns, QueryParameters parameters, ByteBuffer buffer, ResponseWriter writer)
void	executeQuery(String schema, NamedQuery query, TableDefinition requestColumns, QueryParameters params, ResponseWriter writer)
void	executeQuery(String schema, String originalQuery, String loadedQuery, TableDefinition columns, QueryParameters params, ResponseWriter writer)
protected static String	generateColumnName(int columnIndex)
String	getCacheUsage()
Date	getCreateDateTime()
List<ColumnDefinition>	getCustomColumns()
String	getCustomColumnsAsJsonString()
DefaultValues	getDefaultValues()
String	getDefaultValuesAsJsonString()
ClassLoader	getDriverClassLoader()
Set<String>	getDriverUrls()
String	getParametersAsJsonString()
String	getPoolUsage()
int	getQueryTimeout()
int	getQueryTimeout(int customTimeout)
String	getQuoteIdentifier()
TableDefinition	getResultColumns(String schema, String query, QueryParameters params)
TimeZone	getTimeZone()
String	getType() Get type of the entity.
UsageStats	getUsage(String idOrAlias)
int	getWriteTimeout()
int	getWriteTimeout(int customTimeout)
protected TableDefinition	inferTypes(String schema, String originalQuery, String loadedQuery, QueryParameters params)
protected boolean	isSavedQuery(String file)
boolean	isSealed()
String	loadSavedQueryAsNeeded(String normalizedQuery, QueryParameters params)
static NamedDataSource	newInstance(Object... args)
QueryParameters	newQueryParameters(QueryParameters paramsToMerge)
void	validate() Validate this instance and throw runtime exception if something wrong.
protected void	writeMutationResult(long effectedRows, ColumnDefinition[] requestColumns, ColumnDefinition[] customColumns, ResponseWriter writer)
protected void	writeMutationResult(String schema, String originalQuery, String loadedQuery, QueryParameters params, ColumnDefinition[] requestColumns, ColumnDefinition[] customColumns, DefaultValues defaultValues, ResponseWriter writer)
protected void	writeQueryResult(String schema, String originalQuery, String loadedQuery, QueryParameters params, ColumnDefinition[] requestColumns, ColumnDefinition[] customColumns, DefaultValues defaultValues, ResponseWriter writer)

Methods inherited from class ru.yandex.clickhouse.jdbcbridge.core.ManagedEntity

getAliases, getCreationDateTime, getId, isDifferentFrom

Methods inherited from class java.lang.Object

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

Field Detail

CONF_CACHE

protected static final String CONF_CACHE

See Also:

Constant Field Values

CONF_SIZE

protected static final String CONF_SIZE

See Also:

Constant Field Values

CONF_EXPIRATION

protected static final String CONF_EXPIRATION

See Also:

Constant Field Values

CONF_COLUMNS

protected static final String CONF_COLUMNS

See Also:

Constant Field Values

CONF_DEFAULTS

protected static final String CONF_DEFAULTS

See Also:

Constant Field Values

CONF_DRIVER_URLS

protected static final String CONF_DRIVER_URLS

See Also:

Constant Field Values

CONF_PARAMETERS

protected static final String CONF_PARAMETERS

See Also:

Constant Field Values

EMPTY_USAGE

protected static final String EMPTY_USAGE

See Also:

Constant Field Values

CACHE_STAT_HIT_COUNT

protected static final String CACHE_STAT_HIT_COUNT

See Also:

Constant Field Values

CACHE_STAT_MISS_COUNT

protected static final String CACHE_STAT_MISS_COUNT

See Also:

Constant Field Values

CACHE_STAT_LOAD_SUCCESS_COUNT

protected static final String CACHE_STAT_LOAD_SUCCESS_COUNT

See Also:

Constant Field Values

CACHE_STAT_LOAD_FAILURE_COUNT

protected static final String CACHE_STAT_LOAD_FAILURE_COUNT

See Also:

Constant Field Values

CACHE_STAT_TOTAL_LOAD_TIME

protected static final String CACHE_STAT_TOTAL_LOAD_TIME

See Also:

Constant Field Values

CACHE_STAT_EVICTION_COUNT

protected static final String CACHE_STAT_EVICTION_COUNT

See Also:

Constant Field Values

CACHE_STAT_EVICTION_WEIGHT

protected static final String CACHE_STAT_EVICTION_WEIGHT

See Also:

Constant Field Values

COLUMN_PREFIX

protected static final String COLUMN_PREFIX

See Also:

Constant Field Values

DEFAULT_QUOTE_IDENTIFIER

public static final String DEFAULT_QUOTE_IDENTIFIER

See Also:

Constant Field Values

CONF_SCHEMA

public static final String CONF_SCHEMA

See Also:

Constant Field Values

CONF_TYPE

public static final String CONF_TYPE

See Also:

Constant Field Values

CONF_TIMEZONE

public static final String CONF_TIMEZONE

See Also:

Constant Field Values

CONF_QUERY_TIMEOUT

public static final String CONF_QUERY_TIMEOUT

See Also:

Constant Field Values

CONF_WRITE_TIMEOUT

public static final String CONF_WRITE_TIMEOUT

See Also:

Constant Field Values

CONF_SEALED

public static final String CONF_SEALED

See Also:

Constant Field Values

CONF_CONVERTER

public static final String CONF_CONVERTER

See Also:

Constant Field Values

CONF_CLASS

public static final String CONF_CLASS

See Also:

Constant Field Values

CONF_MAPPINGS

public static final String CONF_MAPPINGS

See Also:

Constant Field Values

CONF_JDBC_TYPE

public static final String CONF_JDBC_TYPE

See Also:

Constant Field Values

CONF_JDBC_URL

public static final String CONF_JDBC_URL

See Also:

Constant Field Values

CONF_NATIVE_TYPE

public static final String CONF_NATIVE_TYPE

See Also:

Constant Field Values

CONF_TO_TYPE

public static final String CONF_TO_TYPE

See Also:

Constant Field Values

USE_CUSTOM_DRIVER_LOADER

protected static final boolean USE_CUSTOM_DRIVER_LOADER

converter

protected final DataTypeConverter converter

Constructor Detail

NamedDataSource

public NamedDataSource(String id,
                       Repository<? extends NamedDataSource> repository,
                       io.vertx.core.json.JsonObject config)

Method Detail

newInstance

public static NamedDataSource newInstance(Object... args)

generateColumnName

protected static String generateColumnName(int columnIndex)

inferTypes

protected TableDefinition inferTypes(String schema,
                                     String originalQuery,
                                     String loadedQuery,
                                     QueryParameters params)

isSavedQuery

protected boolean isSavedQuery(String file)

writeMutationResult

protected final void writeMutationResult(long effectedRows,
                                         ColumnDefinition[] requestColumns,
                                         ColumnDefinition[] customColumns,
                                         ResponseWriter writer)

writeMutationResult

protected void writeMutationResult(String schema,
                                   String originalQuery,
                                   String loadedQuery,
                                   QueryParameters params,
                                   ColumnDefinition[] requestColumns,
                                   ColumnDefinition[] customColumns,
                                   DefaultValues defaultValues,
                                   ResponseWriter writer)

writeQueryResult

protected void writeQueryResult(String schema,
                                String originalQuery,
                                String loadedQuery,
                                QueryParameters params,
                                ColumnDefinition[] requestColumns,
                                ColumnDefinition[] customColumns,
                                DefaultValues defaultValues,
                                ResponseWriter writer)

validate

public void validate()

Description copied from class: ManagedEntity

Validate this instance and throw runtime exception if something wrong.

Overrides:

validate in class ManagedEntity

getCacheUsage

public String getCacheUsage()

getPoolUsage

public String getPoolUsage()

getCreateDateTime

public final Date getCreateDateTime()

getDriverUrls

public final Set<String> getDriverUrls()

getDriverClassLoader

public final ClassLoader getDriverClassLoader()

getTimeZone

public final TimeZone getTimeZone()

getQueryTimeout

public final int getQueryTimeout()

getQueryTimeout

public final int getQueryTimeout(int customTimeout)

getWriteTimeout

public final int getWriteTimeout()

getWriteTimeout

public final int getWriteTimeout(int customTimeout)

isSealed

public final boolean isSealed()

getParametersAsJsonString

public final String getParametersAsJsonString()

getResultColumns

public final TableDefinition getResultColumns(String schema,
                                              String query,
                                              QueryParameters params)

getCustomColumns

public final List<ColumnDefinition> getCustomColumns()

getCustomColumnsAsJsonString

public final String getCustomColumnsAsJsonString()

getDefaultValues

public final DefaultValues getDefaultValues()

getDefaultValuesAsJsonString

public final String getDefaultValuesAsJsonString()

newQueryParameters

public final QueryParameters newQueryParameters(QueryParameters paramsToMerge)

executeQuery

public final void executeQuery(String schema,
                               NamedQuery query,
                               TableDefinition requestColumns,
                               QueryParameters params,
                               ResponseWriter writer)

loadSavedQueryAsNeeded

public final String loadSavedQueryAsNeeded(String normalizedQuery,
                                           QueryParameters params)

getUsage

public UsageStats getUsage(String idOrAlias)

Specified by:

getUsage in class ManagedEntity

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

executeQuery

public final void executeQuery(String schema,
                               String originalQuery,
                               String loadedQuery,
                               TableDefinition columns,
                               QueryParameters params,
                               ResponseWriter writer)

executeMutation

public void executeMutation(String schema,
                            String target,
                            TableDefinition columns,
                            QueryParameters parameters,
                            ByteBuffer buffer,
                            ResponseWriter writer)

getQuoteIdentifier

public String getQuoteIdentifier()

getType

public String getType()

Description copied from class: ManagedEntity

Get type of the entity.

Overrides:

getType in class ManagedEntity

Returns:

type of the entity