KsqlConfig¶

ksql.endpoint.migrate.query¶

Enables query request migration (from the /query endpoint to use the same handler as /query-stream)

Default: true

ksql.internal.streams.error.collector¶

Used internally to register a new StreamsErrorCollector when QueryBuilder is requested to buildStreamsProperties.

The StreamsErrorCollector is used for the following:

• recordError when LogMetricAndContinueExceptionHandler is notified about a deserialization error
• cleanup when KsqlEngine.CleanupListener is requested to onClose

ksql.lambdas.enabled¶

Enables lambdas. If true, lambdas are processed normally. If false, new lambda queries won't be processed but existing lambda queries are unaffected.

Default: true

Used when:

• EngineContext is requested to prepare a KSQL statement for execution

ksql.new.query.planner.enabled¶

Enables the new ExecutionPlanner for persistent queries

Default: false

Immutable property

Used when:

• EngineExecutor is requested to throwIfUnsupported

ksql.output.topic.name.prefix¶

ksql.persistence.default.format.value¶

ksql.pull.queries.enable¶

Enables pull queries on a ksqlDB server

Default: true

Used when:

• ImmutableProperties is requested for IMMUTABLE_PROPERTIES
• QueryExecutor is requested to handle a pull query

ksql.query.pull.consistency.token.enabled¶

ksql.query.pull.limit.clause.enabled¶

ksql.query.pull.stream.enabled¶

Enables pull queries on streams

Default: true

Used when:

• KsqlEngine is requested to create a stream pull query

ksql.runtime.feature.shared.enabled¶

Enables shared Kafka Streams runtimes

• false - persistent queries will use separate runtimes
• true - new queries may share streams instances

Default: false

• ALTER SYSTEM commands are not supported when turned off (createForAlterSystemQuery)

Used when:

• EngineExecutor is requested to getApplicationId
• CleanupListener is requested to onClose
• SandboxedExecutionContext is requested to execute a KsqlPlan
• KafkaStreamsQueryValidator is requested to validateCacheBytesUsage
• QueryBuilder is requested to buildStreamsProperties
• QueryRegistryImpl is requested to createOrReplacePersistentQuery
• ValidatedCommandFactory is requested to createForPlannedQuery
• KsqlResource is requested to isValidProperty
• KsqlRestoreCommandTopic is requested to maybeCleanUpQuery
• KsMaterializationFactory is requested to create a KsMaterialization

ksql.rowpartition.rowoffset.enabled¶

Enables ROWPARTITION and ROWOFFSET pseudo-columns in queries

Default: true

Used when:

• LogicalSchema is requested to withPseudoAndKeyColsInValue
• SystemColumns is requested to getPseudoColumnVersionFromConfig
• EngineContext is requested to prepare a KSQL statement
• EngineExecutor is requested to getRowpartitionRowoffsetEnabled
• KsqlEngine is requested to getRowpartitionRowoffsetEnabled
• QueryFilterNode is created
• QueryProjectNode is created
• SchemaKSourceFactory is requested for a SchemaKTable
• ScalablePushUtil is requested to containsDisallowedColumns

ksql.schema.registry.url¶

The URL of the REST endpoint of a schema registry (e.g. Confluent Schema Registry, Apicurio Schema Registry)

Default: (empty)

Used when:

• SchemaRegisterInjector is requested to canRegister
• DefaultSchemaRegistryClient is requested for SCHEMA_REGISTRY_CONFIG_NOT_SET
• KsqlSchemaRegistryClientFactory is created
• KsqlAvroSerdeFactory is requested to getAvroConverter
• KsqlJsonSerdeFactory is requested to getSchemaConverter
• ProtobufSerdeFactory is requested to getConverter
• SourceBuilderUtils is requested to getRegisterCallback

ksql.service.id¶

The ID of the ksql service.

It is used as prefix for all implicitly named resources created by this instance in Kafka. By convention, the id should end in a separator character of some form (e.g. a dash or underscore) as this makes identifiers easier to read.

Default: default_

Used when:

• MetricCollectors is requested to addConfigurableReporter
• DenyListPropertyValidator is created
• QueryApplicationId is requested to buildInternalTopicPrefix
• ReservedInternalTopics is requested to processingLogTopic and toKsqlInternalTopic
• ServiceInfo is created
• CleanupListener is requested to onClose
• OrphanedTransientQueryCleaner is requested to cleanupOrphanedInternalTopics
• QueryLogger is requested to configure
• QueryBuilder is requested to buildStreamsProperties
• KsqlRestApplication is requested to buildApplication, setUpHttpMetrics
• StandaloneExecutorFactory is created
• others

ksql.source.table.materialization.enabled¶

ksql.variable.substitution.enable¶

Enables variable substitution in SQL statements

Default: true

Used when:

• Cli is requested to isVariableSubstitutionEnabled
• RequestHandler is requested to isVariableSubstitutionEnabled
• RequestValidator is requested to isVariableSubstitutionEnabled