Package org.apache.druid.metadata

Class SqlSegmentsMetadataManager

java.lang.Object

org.apache.druid.metadata.SqlSegmentsMetadataManager

All Implemented Interfaces:

SegmentsMetadataManager

public class SqlSegmentsMetadataManager
extends Object
implements SegmentsMetadataManager

Implementation of SegmentsMetadataManager, that periodically polls used segments from the metadata store to build a DataSourcesSnapshot.

Constructor Summary

Constructors

Constructor	Description
SqlSegmentsMetadataManager(com.fasterxml.jackson.databind.ObjectMapper jsonMapper, com.google.common.base.Supplier<SegmentsMetadataManagerConfig> config, com.google.common.base.Supplier<MetadataStorageTablesConfig> dbTables, SQLMetadataConnector connector, SegmentSchemaCache segmentSchemaCache, CentralizedDatasourceSchemaConfig centralizedDatasourceSchemaConfig, ServiceEmitter serviceEmitter)

Method Summary

Modifier and Type	Method	Description
DataSourcesSnapshot	forceUpdateDataSourcesSnapshot()	Forces the manager to poll the metadata store and update its snapshot.
DataSourcesSnapshot	getRecentDataSourcesSnapshot()	Returns the latest snapshot containing all used segments currently cached on the manager.
boolean	isPollingDatabasePeriodically()
void	populateUsedFlagLastUpdatedAsync()	Populates used_status_last_updated column in the segments table iteratively until there are no segments with a NULL value for that column.
void	start()	Initializes the manager when the service is being started.
void	startPollingDatabasePeriodically()	Starts polling segments from the metadata store upon becoming leader.
void	stop()	Cleans up resources when the service is being shut down.
void	stopAsyncUsedFlagLastUpdatedUpdate()
void	stopPollingDatabasePeriodically()	Stops polling segments from the metadata store when leadership is lost.

Methods inherited from class java.lang.Object

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

Constructor Details

SqlSegmentsMetadataManager

public SqlSegmentsMetadataManager(com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 com.google.common.base.Supplier<SegmentsMetadataManagerConfig> config,
 com.google.common.base.Supplier<MetadataStorageTablesConfig> dbTables,
 SQLMetadataConnector connector,
 SegmentSchemaCache segmentSchemaCache,
 CentralizedDatasourceSchemaConfig centralizedDatasourceSchemaConfig,
 ServiceEmitter serviceEmitter)

Method Details

start

public void start()

Description copied from interface: SegmentsMetadataManager

Initializes the manager when the service is being started.

Specified by:

start in interface SegmentsMetadataManager

stop

public void stop()

Description copied from interface: SegmentsMetadataManager

Cleans up resources when the service is being shut down.

Specified by:

stop in interface SegmentsMetadataManager

startPollingDatabasePeriodically

public void startPollingDatabasePeriodically()

Description copied from interface: SegmentsMetadataManager

Starts polling segments from the metadata store upon becoming leader.

Specified by:

startPollingDatabasePeriodically in interface SegmentsMetadataManager

stopAsyncUsedFlagLastUpdatedUpdate

public void stopAsyncUsedFlagLastUpdatedUpdate()

Specified by:

stopAsyncUsedFlagLastUpdatedUpdate in interface SegmentsMetadataManager

populateUsedFlagLastUpdatedAsync

public void populateUsedFlagLastUpdatedAsync()

Description copied from interface: SegmentsMetadataManager

Populates used_status_last_updated column in the segments table iteratively until there are no segments with a NULL value for that column.

Specified by:

populateUsedFlagLastUpdatedAsync in interface SegmentsMetadataManager

isPollingDatabasePeriodically

public boolean isPollingDatabasePeriodically()

Specified by:

isPollingDatabasePeriodically in interface SegmentsMetadataManager

Returns:

true if currently the leader and polling the metadata store.

stopPollingDatabasePeriodically

public void stopPollingDatabasePeriodically()

Description copied from interface: SegmentsMetadataManager

Stops polling segments from the metadata store when leadership is lost.

Specified by:

stopPollingDatabasePeriodically in interface SegmentsMetadataManager

getRecentDataSourcesSnapshot

public DataSourcesSnapshot getRecentDataSourcesSnapshot()

Description copied from interface: SegmentsMetadataManager

Returns the latest snapshot containing all used segments currently cached on the manager. This method returns immediately if the poll period has not elapsed since the latest snapshot was built. Otherwise, it blocks until the snapshot has been refreshed.

Specified by:

getRecentDataSourcesSnapshot in interface SegmentsMetadataManager

forceUpdateDataSourcesSnapshot

public DataSourcesSnapshot forceUpdateDataSourcesSnapshot()

Description copied from interface: SegmentsMetadataManager

Forces the manager to poll the metadata store and update its snapshot. If a poll is already in progress, a new poll is not started. This method blocks until the poll finishes and the snapshot has been refreshed.

Specified by:

forceUpdateDataSourcesSnapshot in interface SegmentsMetadataManager

Returns:

The updated snapshot.