Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added self documentation to the KSQL config public config variables. #422

Merged
3 changes: 1 addition & 2 deletions ksql-cli/src/test/java/io/confluent/ksql/CliTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import org.apache.kafka.connect.data.Schema;
import org.apache.kafka.connect.data.SchemaBuilder;
import org.apache.kafka.streams.StreamsConfig;
import org.apache.kafka.streams.errors.LogAndContinueExceptionHandler;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.ClassRule;
Expand Down Expand Up @@ -163,7 +162,7 @@ private static Map<String, Object> validStartUpConfigs() {

startConfigs.put(SINK_NUMBER_OF_REPLICAS_PROPERTY, 1);
startConfigs.put(SINK_NUMBER_OF_PARTITIONS_PROPERTY, 4);
startConfigs.put(SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_PROPERTY, 1000000);
startConfigs.put(SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_MS_PROPERTY, 1000000);

startConfigs.put(KSQL_TRANSIENT_QUERY_NAME_PREFIX_CONFIG, KSQL_TRANSIENT_QUERY_NAME_PREFIX_DEFAULT);
startConfigs.put(KSQL_SERVICE_ID_CONFIG, KSQL_SERVICE_ID_DEFAULT);
Expand Down
11 changes: 8 additions & 3 deletions ksql-common/src/main/java/io/confluent/ksql/util/KsqlConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class KsqlConfig extends AbstractConfig implements Cloneable {

public static final String SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION =
"WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION";
public static final String SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_PROPERTY =
public static final String SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_MS_PROPERTY =
"ksql.sink.window.change.log.additional.retention";

public static final String STREAM_INTERNAL_CHANGELOG_TOPIC_SUFFIX = "-changelog";
Expand Down Expand Up @@ -125,11 +125,16 @@ public class KsqlConfig extends AbstractConfig implements Cloneable {
ConfigDef.Importance.MEDIUM,
"The default number of replicas for the topics created by KSQL."
)
.define(SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_PROPERTY,
.define(SINK_WINDOW_CHANGE_LOG_ADDITIONAL_RETENTION_MS_PROPERTY,
ConfigDef.Type.LONG,
defaultSinkWindowChangeLogAdditionalRetention,
ConfigDef.Importance.MEDIUM,
"The default window change log additional retention time."
"The default window change log additional retention time. This is a streams "
+ "config value which will be added to a windows maintainMs to ensure data is not "
+ "deleted from "
+ "the "
Copy link
Contributor

@apurvam apurvam Nov 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why these new lines?

ie. why have this string over so many lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it, seems that my intelliJ formatted it that way automatically.

+ "log "
+ "prematurely. Allows for clock drift. Default is 1 day"
)
;
}
Expand Down