/// <summary>
/// Gets the meta data settings from the database configuration service for the specified
/// database name.
/// </summary>
/// <param name="databaseConfigService"></param>
/// <param name="databaseName"></param>
/// <returns></returns>
private static ColumnSettings GetMetaDataSettings(DatabaseConfigService databaseConfigService,
String databaseName)
{
try
{
return(databaseConfigService.GetQuerySetting(databaseName));
}
catch (DatabaseConfigException ex)
{
var text = "Error connecting to database '" + databaseName + '\'';
Log.Error(text, ex);
throw new ExprValidationException(text + ", reason: " + ex.Message, ex);
}
}
/// <summary>
/// Gets the database connection factory.
/// </summary>
/// <param name="databaseConfigService">The database config service.</param>
/// <param name="databaseName">Name of the database.</param>
/// <returns></returns>
private static DatabaseConnectionFactory GetDatabaseConnectionFactory(DatabaseConfigService databaseConfigService, string databaseName)
{
DatabaseConnectionFactory databaseConnectionFactory;
try
{
databaseConnectionFactory = databaseConfigService.GetConnectionFactory(databaseName);
}
catch (DatabaseConfigException ex)
{
var text = "Error connecting to database '" + databaseName + "'";
Log.Error(text, ex);
throw new ExprValidationException(text + ", reason: " + ex.Message, ex);
}
return(databaseConnectionFactory);
}
// Supplied after construction to avoid circular dependency
/// <summary>
/// Constructor - sets up new set of services.
/// </summary>
/// <param name="engineURI">is the engine URI</param>
/// <param name="schedulingService">service to get time and schedule callbacks</param>
/// <param name="eventAdapterService">service to resolve event types</param>
/// <param name="engineImportService">is engine imported static func packages and aggregation functions</param>
/// <param name="engineSettingsService">provides engine settings</param>
/// <param name="databaseConfigService">service to resolve a database name to database connection factory and configs</param>
/// <param name="plugInViews">resolves view namespace and name to view factory class</param>
/// <param name="statementLockFactory">creates statement-level locks</param>
/// <param name="eventProcessingRWLock">is the engine lock for statement management</param>
/// <param name="extensionServicesContext">marker interface allows adding additional services</param>
/// <param name="engineEnvContext">is engine environment/directory information for use with adapters and external env</param>
/// <param name="statementContextFactory">is the factory to use to create statement context objects</param>
/// <param name="plugInPatternObjects">resolves plug-in pattern objects</param>
/// <param name="timerService">is the timer service</param>
/// <param name="filterService">the filter service</param>
/// <param name="streamFactoryService">is hooking up filters to streams</param>
/// <param name="namedWindowMgmtService">The named window MGMT service.</param>
/// <param name="namedWindowDispatchService">The named window dispatch service.</param>
/// <param name="variableService">provides access to variable values</param>
/// <param name="tableService">The table service.</param>
/// <param name="timeSourceService">time source provider class</param>
/// <param name="valueAddEventService">handles Update events</param>
/// <param name="metricsReportingService">for metric reporting</param>
/// <param name="statementEventTypeRef">statement to event type reference holding</param>
/// <param name="statementVariableRef">statement to variabke reference holding</param>
/// <param name="configSnapshot">configuration snapshot</param>
/// <param name="threadingServiceImpl">engine-level threading services</param>
/// <param name="internalEventRouter">routing of events</param>
/// <param name="statementIsolationService">maintains isolation information per statement</param>
/// <param name="schedulingMgmtService">schedule management for statements</param>
/// <param name="deploymentStateService">The deployment state service.</param>
/// <param name="exceptionHandlingService">The exception handling service.</param>
/// <param name="patternNodeFactory">The pattern node factory.</param>
/// <param name="eventTypeIdGenerator">The event type id generator.</param>
/// <param name="statementMetadataFactory">The statement metadata factory.</param>
/// <param name="contextManagementService">The context management service.</param>
/// <param name="patternSubexpressionPoolSvc">The pattern subexpression pool SVC.</param>
/// <param name="matchRecognizeStatePoolEngineSvc">The match recognize state pool engine SVC.</param>
/// <param name="dataFlowService">The data flow service.</param>
/// <param name="exprDeclaredService">The expr declared service.</param>
/// <param name="contextControllerFactoryFactorySvc">The context controller factory factory SVC.</param>
/// <param name="contextManagerFactoryService">The context manager factory service.</param>
/// <param name="epStatementFactory">The ep statement factory.</param>
/// <param name="regexHandlerFactory">The regex handler factory.</param>
/// <param name="viewableActivatorFactory">The viewable activator factory.</param>
/// <param name="filterNonPropertyRegisteryService">The filter non property registery service.</param>
/// <param name="resultSetProcessorHelperFactory">The result set processor helper factory.</param>
/// <param name="viewServicePreviousFactory">The view service previous factory.</param>
/// <param name="eventTableIndexService">The event table index service.</param>
/// <param name="epRuntimeIsolatedFactory">The ep runtime isolated factory.</param>
/// <param name="filterBooleanExpressionFactory">The filter boolean expression factory.</param>
/// <param name="dataCacheFactory">The data cache factory.</param>
/// <param name="multiMatchHandlerFactory">The multi match handler factory.</param>
/// <param name="namedWindowConsumerMgmtService">The named window consumer MGMT service.</param>
/// <param name="aggregationFactoryFactory"></param>
/// <param name="scriptingService">The scripting service.</param>
public EPServicesContext(
string engineURI,
SchedulingServiceSPI schedulingService,
EventAdapterService eventAdapterService,
EngineImportService engineImportService,
EngineSettingsService engineSettingsService,
DatabaseConfigService databaseConfigService,
PluggableObjectCollection plugInViews,
StatementLockFactory statementLockFactory,
IReaderWriterLock eventProcessingRWLock,
EngineLevelExtensionServicesContext extensionServicesContext,
Directory engineEnvContext,
StatementContextFactory statementContextFactory,
PluggableObjectCollection plugInPatternObjects,
TimerService timerService,
FilterServiceSPI filterService,
StreamFactoryService streamFactoryService,
NamedWindowMgmtService namedWindowMgmtService,
NamedWindowDispatchService namedWindowDispatchService,
VariableService variableService,
TableService tableService,
TimeSourceService timeSourceService,
ValueAddEventService valueAddEventService,
MetricReportingServiceSPI metricsReportingService,
StatementEventTypeRef statementEventTypeRef,
StatementVariableRef statementVariableRef,
ConfigurationInformation configSnapshot,
ThreadingService threadingServiceImpl,
InternalEventRouterImpl internalEventRouter,
StatementIsolationService statementIsolationService,
SchedulingMgmtService schedulingMgmtService,
DeploymentStateService deploymentStateService,
ExceptionHandlingService exceptionHandlingService,
PatternNodeFactory patternNodeFactory,
EventTypeIdGenerator eventTypeIdGenerator,
StatementMetadataFactory statementMetadataFactory,
ContextManagementService contextManagementService,
PatternSubexpressionPoolEngineSvc patternSubexpressionPoolSvc,
MatchRecognizeStatePoolEngineSvc matchRecognizeStatePoolEngineSvc,
DataFlowService dataFlowService,
ExprDeclaredService exprDeclaredService,
ContextControllerFactoryFactorySvc contextControllerFactoryFactorySvc,
ContextManagerFactoryService contextManagerFactoryService,
EPStatementFactory epStatementFactory,
RegexHandlerFactory regexHandlerFactory,
ViewableActivatorFactory viewableActivatorFactory,
FilterNonPropertyRegisteryService filterNonPropertyRegisteryService,
ResultSetProcessorHelperFactory resultSetProcessorHelperFactory,
ViewServicePreviousFactory viewServicePreviousFactory,
EventTableIndexService eventTableIndexService,
EPRuntimeIsolatedFactory epRuntimeIsolatedFactory,
FilterBooleanExpressionFactory filterBooleanExpressionFactory,
DataCacheFactory dataCacheFactory,
MultiMatchHandlerFactory multiMatchHandlerFactory,
NamedWindowConsumerMgmtService namedWindowConsumerMgmtService,
AggregationFactoryFactory aggregationFactoryFactory,
ScriptingService scriptingService)
{
EngineURI = engineURI;
SchedulingService = schedulingService;
EventAdapterService = eventAdapterService;
EngineImportService = engineImportService;
EngineSettingsService = engineSettingsService;
DatabaseRefService = databaseConfigService;
FilterService = filterService;
TimerService = timerService;
DispatchService = DispatchServiceProvider.NewService();
ViewService = ViewServiceProvider.NewService();
StreamService = streamFactoryService;
PlugInViews = plugInViews;
StatementLockFactory = statementLockFactory;
EventProcessingRWLock = eventProcessingRWLock;
EngineLevelExtensionServicesContext = extensionServicesContext;
EngineEnvContext = engineEnvContext;
StatementContextFactory = statementContextFactory;
PlugInPatternObjects = plugInPatternObjects;
NamedWindowMgmtService = namedWindowMgmtService;
NamedWindowDispatchService = namedWindowDispatchService;
VariableService = variableService;
TableService = tableService;
TimeSource = timeSourceService;
ValueAddEventService = valueAddEventService;
MetricsReportingService = metricsReportingService;
StatementEventTypeRefService = statementEventTypeRef;
ConfigSnapshot = configSnapshot;
ThreadingService = threadingServiceImpl;
InternalEventRouter = internalEventRouter;
StatementIsolationService = statementIsolationService;
SchedulingMgmtService = schedulingMgmtService;
StatementVariableRefService = statementVariableRef;
DeploymentStateService = deploymentStateService;
ExceptionHandlingService = exceptionHandlingService;
PatternNodeFactory = patternNodeFactory;
EventTypeIdGenerator = eventTypeIdGenerator;
StatementMetadataFactory = statementMetadataFactory;
ContextManagementService = contextManagementService;
PatternSubexpressionPoolSvc = patternSubexpressionPoolSvc;
MatchRecognizeStatePoolEngineSvc = matchRecognizeStatePoolEngineSvc;
DataFlowService = dataFlowService;
ExprDeclaredService = exprDeclaredService;
ExpressionResultCacheSharable = new ExpressionResultCacheService(
configSnapshot.EngineDefaults.ExecutionConfig.DeclaredExprValueCacheSize);
ContextControllerFactoryFactorySvc = contextControllerFactoryFactorySvc;
ContextManagerFactoryService = contextManagerFactoryService;
EpStatementFactory = epStatementFactory;
RegexHandlerFactory = regexHandlerFactory;
ViewableActivatorFactory = viewableActivatorFactory;
FilterNonPropertyRegisteryService = filterNonPropertyRegisteryService;
ResultSetProcessorHelperFactory = resultSetProcessorHelperFactory;
ViewServicePreviousFactory = viewServicePreviousFactory;
EventTableIndexService = eventTableIndexService;
EpRuntimeIsolatedFactory = epRuntimeIsolatedFactory;
FilterBooleanExpressionFactory = filterBooleanExpressionFactory;
DataCacheFactory = dataCacheFactory;
MultiMatchHandlerFactory = multiMatchHandlerFactory;
NamedWindowConsumerMgmtService = namedWindowConsumerMgmtService;
AggregationFactoryFactory = aggregationFactoryFactory;
ScriptingService = scriptingService;
}
/// <summary>
/// Creates the viewable for polling via database SQL query.
/// </summary>
/// <param name="statementId">The statement id.</param>
/// <param name="streamNumber">is the stream number of the view</param>
/// <param name="databaseStreamSpec">provides the SQL statement, database name and additional info</param>
/// <param name="databaseConfigService">for getting database connection and settings</param>
/// <param name="eventAdapterService">for generating event beans from database information</param>
/// <param name="epStatementAgentInstanceHandle">The ep statement agent instance handle.</param>
/// <param name="contextAttributes">The db attributes.</param>
/// <param name="columnTypeConversionHook">The column type conversion hook.</param>
/// <param name="outputRowConversionHook">The output row conversion hook.</param>
/// <param name="enableAdoLogging">if set to <c>true</c> [enable JDBC logging].</param>
/// <param name="dataCacheFactory">The data cache factory.</param>
/// <param name="statementContext">The statement context.</param>
/// <returns>
/// viewable providing poll functionality
/// </returns>
/// <exception cref="ExprValidationException">the validation failed</exception>
public static HistoricalEventViewable CreateDBStatementView(
int statementId,
int streamNumber,
DBStatementStreamSpec databaseStreamSpec,
DatabaseConfigService databaseConfigService,
EventAdapterService eventAdapterService,
EPStatementAgentInstanceHandle epStatementAgentInstanceHandle,
IEnumerable <Attribute> contextAttributes,
SQLColumnTypeConversion columnTypeConversionHook,
SQLOutputRowConversion outputRowConversionHook,
bool enableAdoLogging,
DataCacheFactory dataCacheFactory,
StatementContext statementContext)
{
// Parse the SQL for placeholders and text fragments
var sqlFragments = GetSqlFragments(databaseStreamSpec);
IList <String> invocationInputParameters = new List <string>();
foreach (var fragment in sqlFragments)
{
if ((fragment.IsParameter) && (fragment.Value != SAMPLE_WHERECLAUSE_PLACEHOLDER))
{
invocationInputParameters.Add(fragment.Value);
}
}
// Get the database information
var databaseName = databaseStreamSpec.DatabaseName;
var dbDriver = GetDatabaseConnectionFactory(databaseConfigService, databaseName).Driver;
var dbCommand = dbDriver.CreateCommand(
sqlFragments,
GetMetaDataSettings(databaseConfigService, databaseName),
contextAttributes);
if (Log.IsDebugEnabled)
{
Log.Debug(".CreateDBStatementView dbCommand=" + dbCommand);
}
var queryMetaData = GetQueryMetaData(
databaseStreamSpec,
databaseConfigService,
dbCommand,
contextAttributes);
Func <SQLColumnTypeContext, Type> columnTypeConversionFunc = null;
if (columnTypeConversionHook != null)
{
columnTypeConversionFunc = columnTypeConversionHook.GetColumnType;
}
Func <SQLOutputRowTypeContext, Type> outputRowConversionFunc = null;
if (outputRowConversionHook != null)
{
outputRowConversionFunc = outputRowConversionHook.GetOutputRowType;
}
// Construct an event type from SQL query result metadata
var eventType = CreateEventType(
statementId,
streamNumber,
queryMetaData,
eventAdapterService,
databaseStreamSpec,
columnTypeConversionFunc,
outputRowConversionFunc);
// Get a proper connection and data cache
ConnectionCache connectionCache;
DataCache dataCache;
try
{
connectionCache = databaseConfigService.GetConnectionCache(
databaseName, dbCommand.PseudoText, contextAttributes);
dataCache = databaseConfigService.GetDataCache(
databaseName, statementContext, epStatementAgentInstanceHandle, dataCacheFactory, streamNumber);
}
catch (DatabaseConfigException e)
{
const string text = "Error obtaining cache configuration";
Log.Error(text, e);
throw new ExprValidationException(text + ", reason: " + e.Message, e);
}
var dbPollStrategy = new PollExecStrategyDBQuery(
eventAdapterService,
eventType,
connectionCache,
dbCommand.CommandText,
queryMetaData.OutputParameters,
columnTypeConversionHook,
outputRowConversionHook);
return(new DatabasePollingViewable(
streamNumber,
invocationInputParameters,
dbPollStrategy,
dataCache,
eventType));
}
/// <summary>
/// Gets the query meta data.
/// </summary>
/// <param name="databaseStreamSpec">The database stream spec.</param>
/// <param name="databaseConfigService">The database config service.</param>
/// <param name="dbCommand">The database command.</param>
/// <param name="contextAttributes">The context attributes.</param>
/// <returns></returns>
private static QueryMetaData GetQueryMetaData(
DBStatementStreamSpec databaseStreamSpec,
DatabaseConfigService databaseConfigService,
DbDriverCommand dbCommand,
IEnumerable <Attribute> contextAttributes)
{
// Get a database connection
var databaseName = databaseStreamSpec.DatabaseName;
//DatabaseConnectionFactory databaseConnectionFactory = GetDatabaseConnectionFactory(databaseConfigService, databaseName);
var metadataSetting = dbCommand.MetaDataSettings;
QueryMetaData queryMetaData;
try
{
// On default setting, if we detect Oracle in the connection then don't query metadata from prepared statement
var metaOriginPolicy = metadataSetting.MetadataRetrievalEnum;
if (metaOriginPolicy == ConfigurationDBRef.MetadataOriginEnum.DEFAULT)
{
// Ask the driver how it interprets the default meta origin policy; the
// esper code has a specific hook for Oracle. We have moved this into
// the driver to avoid specifically coding behavior to a driver.
metaOriginPolicy = dbCommand.Driver.DefaultMetaOriginPolicy;
}
switch (metaOriginPolicy)
{
case ConfigurationDBRef.MetadataOriginEnum.METADATA:
case ConfigurationDBRef.MetadataOriginEnum.DEFAULT:
queryMetaData = dbCommand.MetaData;
break;
case ConfigurationDBRef.MetadataOriginEnum.SAMPLE:
{
var parameterDesc = dbCommand.ParameterDescription;
String sampleSQL;
if (databaseStreamSpec.MetadataSQL != null)
{
sampleSQL = databaseStreamSpec.MetadataSQL;
if (Log.IsInfoEnabled)
{
Log.Info(".GetQueryMetaData Using provided sample SQL '" + sampleSQL + "'");
}
}
else
{
// Create the sample SQL by replacing placeholders with null and
// SAMPLE_WHERECLAUSE_PLACEHOLDER with a "where 1=0" clause
sampleSQL = CreateSamplePlaceholderStatement(dbCommand.Fragments);
if (Log.IsInfoEnabled)
{
Log.Info(".GetQueryMetaData Using un-lexed sample SQL '" + sampleSQL + "'");
}
// If there is no SAMPLE_WHERECLAUSE_PLACEHOLDER, lexical analyse the SQL
// adding a "where 1=0" clause.
if (parameterDesc.BuiltinIdentifiers.Count != 1)
{
sampleSQL = LexSampleSQL(sampleSQL);
if (Log.IsInfoEnabled)
{
Log.Info(".GetQueryMetaData Using lexed sample SQL '" + sampleSQL + "'");
}
}
}
// finally get the metadata by firing the sample SQL
queryMetaData = GetExampleQueryMetaData(
dbCommand.Driver, sampleSQL, metadataSetting, contextAttributes);
}
break;
default:
throw new ArgumentException(
"MetaOriginPolicy contained an unhandled value: #" + metaOriginPolicy);
}
}
catch (DatabaseConfigException ex)
{
var text = "Error connecting to database '" + databaseName + '\'';
Log.Error(text, ex);
throw new ExprValidationException(text + ", reason: " + ex.Message, ex);
}
return(queryMetaData);
}
