org.apache.druid.metadata

Class SQLMetadataConnector

java.lang.Object

org.apache.druid.metadata.SQLMetadataConnector

All Implemented Interfaces:

MetadataStorageConnector

Direct Known Subclasses:

DerbyConnector

public abstract class SQLMetadataConnector
extends Object
implements MetadataStorageConnector

Field Summary

Fields inherited from interface org.apache.druid.metadata.MetadataStorageConnector

CONFIG_TABLE_KEY_COLUMN, CONFIG_TABLE_VALUE_COLUMN

Constructor Summary

Constructors

Constructor and Description
SQLMetadataConnector(com.google.common.base.Supplier<MetadataStorageConnectorConfig> config, com.google.common.base.Supplier<MetadataStorageTablesConfig> tablesConfigSupplier)

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSwap(List<MetadataCASUpdate> updates)
protected boolean	connectorIsTransientException(Throwable e) Vendor specific errors that are not covered by isTransientException(Throwable)
void	createAuditTable()
void	createConfigTable()
void	createConfigTable(String tableName)
void	createDataSourceTable()
void	createDataSourceTable(String tableName)
void	createEntryTable(String tableName)
void	createIndex(String tableName, String indexName, List<String> indexCols, Set<String> createdIndexSet) create index on the table with retry if not already exist, to be called after createTable
void	createLockTable(String tableName, String entryTypeName)
void	createLogTable(String tableName, String entryTypeName)
void	createPendingSegmentsTable()
void	createPendingSegmentsTable(String tableName)
void	createRulesTable()
void	createRulesTable(String tableName)
void	createSegmentTable()
void	createSegmentTable(String tableName)
void	createSupervisorsTable()
void	createSupervisorsTable(String tableName)
void	createTable(String tableName, Iterable<String> sql)
void	createTaskTables()
void	deleteAllRecords(String tableName)
String	getCollation() The character set and collation for case-sensitive nonbinary string comparison
MetadataStorageConnectorConfig	getConfig()
protected org.apache.commons.dbcp2.BasicDataSource	getDatasource()
abstract org.skife.jdbi.v2.DBI	getDBI()
ResultSet	getIndexInfo(DatabaseMetaData databaseMetaData, String tableName) Get the ResultSet for indexInfo for given table
Set<String>	getIndexOnTable(String tableName) Get the Set of the index on given table
String	getPayloadType() SQL type to use for payload data (e.g.
abstract String	getQuoteString()
abstract String	getSerialType() Auto-incrementing SQL type to use for IDs Must be an integer type, which values will be automatically set by the database The resulting string will be interpolated into the table creation statement, e.g.
abstract int	getStreamingFetchSize() Returns the value that should be passed to statement.setFetchSize to ensure results are streamed back from the database instead of fetching the entire result set in memory.
String	getValidationQuery()
protected <T> T	inReadOnlyTransaction(org.skife.jdbi.v2.TransactionCallback<T> callback)
Void	insertOrUpdate(String tableName, String keyColumn, String valueColumn, String key, byte[] value)
protected boolean	isRootCausePacketTooBigException(Throwable t) Checks if the root cause of the given exception is a PacketTooBigException.
boolean	isTransientException(Throwable e)
abstract String	limitClause(int limit)
byte[]	lookup(String tableName, String keyColumn, String valueColumn, String key)
byte[]	lookupWithHandle(org.skife.jdbi.v2.Handle handle, String tableName, String keyColumn, String valueColumn, String key)
protected static org.apache.commons.dbcp2.BasicDataSource	makeDatasource(MetadataStorageConnectorConfig connectorConfig, String validationQuery)
void	prepareTaskEntryTable(String tableName)
<T> T	retryTransaction(org.skife.jdbi.v2.TransactionCallback<T> callback, int quietTries, int maxTries)
<T> T	retryWithHandle(org.skife.jdbi.v2.tweak.HandleCallback<T> callback)
<T> T	retryWithHandle(org.skife.jdbi.v2.tweak.HandleCallback<T> callback, com.google.common.base.Predicate<Throwable> myShouldRetry)
boolean	tableContainsColumn(org.skife.jdbi.v2.Handle handle, String table, String column)
abstract boolean	tableExists(org.skife.jdbi.v2.Handle handle, String tableName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.metadata.MetadataStorageConnector

exportTable

Constructor Detail

SQLMetadataConnector

public SQLMetadataConnector(com.google.common.base.Supplier<MetadataStorageConnectorConfig> config,
                            com.google.common.base.Supplier<MetadataStorageTablesConfig> tablesConfigSupplier)

Method Detail

getPayloadType

public String getPayloadType()

SQL type to use for payload data (e.g. JSON blobs). Must be a binary type, which values can be accessed using ResultSet.getBytes()

The resulting string will be interpolated into the table creation statement, e.g. CREATE TABLE druid_table ( payload NOT NULL, ... )

Returns:

String representing the SQL type

getCollation

public String getCollation()

The character set and collation for case-sensitive nonbinary string comparison

Returns:

the collation for the character set

getSerialType

public abstract String getSerialType()

Auto-incrementing SQL type to use for IDs Must be an integer type, which values will be automatically set by the database

The resulting string will be interpolated into the table creation statement, e.g. CREATE TABLE druid_table ( id NOT NULL, ... )

Returns:

String representing the SQL type and auto-increment statement

getStreamingFetchSize

public abstract int getStreamingFetchSize()

Returns the value that should be passed to statement.setFetchSize to ensure results are streamed back from the database instead of fetching the entire result set in memory.

Returns:

optimal fetch size to stream results back

getQuoteString

public abstract String getQuoteString()

Returns:

the string that should be used to quote string fields

getValidationQuery

public String getValidationQuery()

tableExists

public abstract boolean tableExists(org.skife.jdbi.v2.Handle handle,
                                    String tableName)

limitClause

public abstract String limitClause(int limit)

retryWithHandle

public <T> T retryWithHandle(org.skife.jdbi.v2.tweak.HandleCallback<T> callback,
                             com.google.common.base.Predicate<Throwable> myShouldRetry)

retryWithHandle

public <T> T retryWithHandle(org.skife.jdbi.v2.tweak.HandleCallback<T> callback)

retryTransaction

public <T> T retryTransaction(org.skife.jdbi.v2.TransactionCallback<T> callback,
                              int quietTries,
                              int maxTries)

isTransientException

public final boolean isTransientException(Throwable e)

connectorIsTransientException

protected boolean connectorIsTransientException(Throwable e)

Vendor specific errors that are not covered by isTransientException(Throwable)

isRootCausePacketTooBigException

protected boolean isRootCausePacketTooBigException(Throwable t)

Checks if the root cause of the given exception is a PacketTooBigException.

Returns:

false by default. Specific implementations should override this method to correctly classify their packet exceptions.

createTable

public void createTable(String tableName,
                        Iterable<String> sql)

createPendingSegmentsTable

public void createPendingSegmentsTable(String tableName)

createDataSourceTable

public void createDataSourceTable(String tableName)

createSegmentTable

public void createSegmentTable(String tableName)

createRulesTable

public void createRulesTable(String tableName)

createConfigTable

public void createConfigTable(String tableName)

tableContainsColumn

public boolean tableContainsColumn(org.skife.jdbi.v2.Handle handle,
                                   String table,
                                   String column)

prepareTaskEntryTable

public void prepareTaskEntryTable(String tableName)

createEntryTable

public void createEntryTable(String tableName)

createLogTable

public void createLogTable(String tableName,
                           String entryTypeName)

createLockTable

public void createLockTable(String tableName,
                            String entryTypeName)

createSupervisorsTable

public void createSupervisorsTable(String tableName)

insertOrUpdate

public Void insertOrUpdate(String tableName,
                           String keyColumn,
                           String valueColumn,
                           String key,
                           byte[] value)

Specified by:

insertOrUpdate in interface MetadataStorageConnector

compareAndSwap

public boolean compareAndSwap(List<MetadataCASUpdate> updates)

Specified by:

compareAndSwap in interface MetadataStorageConnector

getDBI

public abstract org.skife.jdbi.v2.DBI getDBI()

createDataSourceTable

public void createDataSourceTable()

Specified by:

createDataSourceTable in interface MetadataStorageConnector

createPendingSegmentsTable

public void createPendingSegmentsTable()

Specified by:

createPendingSegmentsTable in interface MetadataStorageConnector

createSegmentTable

public void createSegmentTable()

Specified by:

createSegmentTable in interface MetadataStorageConnector

createRulesTable

public void createRulesTable()

Specified by:

createRulesTable in interface MetadataStorageConnector

createConfigTable

public void createConfigTable()

Specified by:

createConfigTable in interface MetadataStorageConnector

createTaskTables

public void createTaskTables()

Specified by:

createTaskTables in interface MetadataStorageConnector

createSupervisorsTable

public void createSupervisorsTable()

Specified by:

createSupervisorsTable in interface MetadataStorageConnector

lookup

@Nullable
public byte[] lookup(String tableName,
                               String keyColumn,
                               String valueColumn,
                               String key)

Specified by:

lookup in interface MetadataStorageConnector

lookupWithHandle

@Nullable
public byte[] lookupWithHandle(org.skife.jdbi.v2.Handle handle,
                                         String tableName,
                                         String keyColumn,
                                         String valueColumn,
                                         String key)

getConfig

public MetadataStorageConnectorConfig getConfig()

makeDatasource

protected static org.apache.commons.dbcp2.BasicDataSource makeDatasource(MetadataStorageConnectorConfig connectorConfig,
                                                                         String validationQuery)

getDatasource

protected org.apache.commons.dbcp2.BasicDataSource getDatasource()

inReadOnlyTransaction

protected final <T> T inReadOnlyTransaction(org.skife.jdbi.v2.TransactionCallback<T> callback)

createAuditTable

public void createAuditTable()

Specified by:

createAuditTable in interface MetadataStorageConnector

deleteAllRecords

public void deleteAllRecords(String tableName)

Specified by:

deleteAllRecords in interface MetadataStorageConnector

getIndexOnTable

public Set<String> getIndexOnTable(String tableName)

Get the Set of the index on given table

Parameters:

tableName - name of the table to fetch the index map

Returns:

Set of the uppercase index names, returns empty set if table does not exist

getIndexInfo

public ResultSet getIndexInfo(DatabaseMetaData databaseMetaData,
                              String tableName)
                       throws SQLException

Get the ResultSet for indexInfo for given table

Parameters:

databaseMetaData - DatabaseMetaData

tableName - Name of table

Returns:

ResultSet with index info

Throws:

SQLException

createIndex

public void createIndex(String tableName,
                        String indexName,
                        List<String> indexCols,
                        Set<String> createdIndexSet)

create index on the table with retry if not already exist, to be called after createTable

Parameters:

tableName - Name of the table to create index on

indexName - case-insensitive string index name, it helps to check the existing index on table

indexCols - List of columns to be indexed on

createdIndexSet -