io.druid.metadata

Class SQLMetadataConnector

java.lang.Object

io.druid.metadata.SQLMetadataConnector

All Implemented Interfaces:

MetadataStorageConnector

Direct Known Subclasses:

DerbyConnector, MySQLConnector, PostgreSQLConnector, SQLServerConnector

public abstract class SQLMetadataConnector
extends Object
implements MetadataStorageConnector

Field Summary

Fields inherited from interface io.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) Atomic compare-and-swap variant of insertOrUpdate().
protected boolean	connectorIsTransientException(Throwable e)
void	createAuditTable()
void	createConfigTable()
void	createConfigTable(String tableName)
void	createDataSourceTable()
void	createDataSourceTable(String tableName)
void	createEntryTable(String tableName)
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)
MetadataStorageConnectorConfig	getConfig()
protected org.apache.commons.dbcp2.BasicDataSource	getDatasource()
abstract org.skife.jdbi.v2.DBI	getDBI()
protected String	getPayloadType() SQL type to use for payload data (e.g.
abstract String	getQuoteString()
protected 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.
protected 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)
boolean	isTransientException(Throwable e)
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)
<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)
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

Constructor Detail

SQLMetadataConnector

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

Method Detail

getPayloadType

protected 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

getSerialType

protected 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

protected 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)

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)

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)

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)
                    throws Exception

Specified by:

insertOrUpdate in interface MetadataStorageConnector

Throws:

Exception

compareAndSwap

public boolean compareAndSwap(List<MetadataCASUpdate> updates)
                       throws Exception

Description copied from interface: MetadataStorageConnector

Atomic compare-and-swap variant of insertOrUpdate().

Specified by:

compareAndSwap in interface MetadataStorageConnector

Parameters:

updates - Set of updates to be made. If compare checks succeed for all updates, perform all updates. If any compare check fails, reject all updates.

Returns:

true if updates were made, false otherwise

Throws:

Exception

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

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

Specified by:

lookup in interface MetadataStorageConnector

lookupWithHandle

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

getConfig

public MetadataStorageConnectorConfig getConfig()

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