KsqlExecutionContext¶

KsqlExecutionContext is an abstraction of execution contexts.

Contract (Subset)¶

Creating Stream Pull Query¶

StreamPullQueryMetadata createStreamPullQuery(
  ServiceContext serviceContext,
  ImmutableAnalysis analysis,
  ConfiguredStatement<Query> statementOrig,
  boolean excludeTombstones)

See KsqlEngine

Used when:

• QueryExecutor is requested to handle a stream pull query

Creating Sandboxed Execution Context (createSandbox)¶

KsqlExecutionContext createSandbox(
  ServiceContext serviceContext)

Used when:

• KsqlContext is requested to execute a SQL text
• DefaultSchemaInjector is requested to forCreateAsStatement
• SchemaRegisterInjector is requested to registerForCreateAs
• StandaloneExecutor is requested to validateStatements
• DistributingExecutor is requested to execute
• ExplainExecutor is requested to explainStatement
• KsqlResource is requested to configure

Statement Execution (execute)¶

ExecuteResult execute(
  ServiceContext serviceContext,
  ConfiguredKsqlPlan plan)
ExecuteResult execute(
  ServiceContext serviceContext,
  ConfiguredStatement<?> statement)

Executes a KsqlPlan or a Statement

Used when:

• InteractiveStatementExecutor is requested to execute a KsqlPlan
• KsqlContext is requested to execute a statement
• StandaloneExecutor.StatementExecutor is requested to handleExecutableDdl and handlePersistentQuery
• ExplainExecutor is requested to explain a Statement
• KsqlRestApplication is requested to registerCommandTopic
• ValidatedCommandFactory is requested to createForPlannedQuery

Executing Scalable Push Query¶

ScalablePushQueryMetadata executeScalablePushQuery(
  ImmutableAnalysis analysis,
  ServiceContext serviceContext,
  ConfiguredStatement<Query> statement,
  PushRouting pushRouting,
  PushRoutingOptions pushRoutingOptions,
  QueryPlannerOptions queryPlannerOptions,
  Context context,
  Optional<ScalablePushQueryMetrics> scalablePushQueryMetrics)

Used when:

• QueryExecutor is requested to handle a scalable push query

Executing Table Pull Query¶

PullQueryResult executeTablePullQuery(
  ImmutableAnalysis analysis,
  ServiceContext serviceContext,
  ConfiguredStatement<Query> statement,
  HARouting routing,
  RoutingOptions routingOptions,
  QueryPlannerOptions queryPlannerOptions,
  Optional<PullQueryExecutorMetrics> pullQueryMetrics,
  boolean startImmediately,
  Optional<ConsistencyOffsetVector> consistencyOffsetVector)

Used when:

• QueryExecutor is requested to handleTablePullQuery

Executing Transient Query¶

TransientQueryMetadata executeTransientQuery(
  ServiceContext serviceContext,
  ConfiguredStatement<Query> statement,
  boolean excludeTombstones)

Used when:

• CustomExecutors is requested to handle a QUERY statement
• ExplainExecutor is requested to explain a QUERY statement
• QueryExecutor is requested to handlePushQuery

getAllLiveQueries¶

List<QueryMetadata> getAllLiveQueries()

Used when:

• ListQueriesExecutor is requested to getLocalSimple, getLocalExtended
• QueryCapacityUtil utility is used to getNumLivePushQueries

getPersistentQueries¶

List<PersistentQueryMetadata> getPersistentQueries()

Used when:

• KsqlContext is requested to getPersistentQueries
• KsqlEngineMetrics is requested to configureNumPersistentQueries and configureGaugeForState
• PersistentQuerySaturationMetrics is requested to run
• DiscoverClusterService is requested to runOneIteration
• SendLagService is requested to runOneIteration
• StandaloneExecutor is requested to processesQueryFile
• CommandRunner is requested to processPriorCommands
• others

Parsing SQL Text¶

List<ParsedStatement> parse(
  String sql)

Used when:

• KsqlContext is requested to sql
• SqlFormatInjector is requested to inject
• QueryEndpoint is requested to createStatement
• KsqlRestApplication is requested to registerCommandTopic
• StandaloneExecutor is requested to processesQueryFile
• StatementParser is requested to parseSingleStatement
• KsqlResource is requested to handleKsqlStatements

Statement Planning (plan)¶

KsqlPlan plan(
  ServiceContext serviceContext,
  ConfiguredStatement<?> statement)

Plans a given DDL/DML statement (in the ServiceContext) and creates a KsqlPlan

See KsqlEngine or SandboxedExecutionContext

Used when:

• KsqlEngine is requested to execute a statement
• SandboxedExecutionContext is requested to execute a statement
• DefaultSchemaInjector is requested to forCreateAsStatement
• SchemaRegisterInjector is requested to registerForCreateAs
• ValidatedCommandFactory is requested to createForPlannedQuery

Preparing Statement for Execution¶

PreparedStatement<?> prepare(
  ParsedStatement stmt,
  Map<String, String> variablesMap)
PreparedStatement<?> prepare(
  ParsedStatement stmt) // (1)!

1. Uses an empty Map

Used when:

• KsqlContext is requested to execute
• KsqlRestApplication is requested to registerCommandTopic
• QueryEndpoint is requested to createStatement
• RequestHandler is requested to execute
• RequestValidator is requested to validate
• SqlFormatInjector is requested to inject
• StandaloneExecutor.StatementExecutor is requested to prepare a statement
• StatementParser is requested to parseSingleStatement

updateStreamsPropertiesAndRestartRuntime¶

void updateStreamsPropertiesAndRestartRuntime()

Used when:

• InteractiveStatementExecutor is requested to execute an ALTER SYSTEM command

Implementations¶

• KsqlEngine
• SandboxedExecutionContext