Skip to content

Change DateTimeFormatSpec delimiter #8727

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.

Sign up for GitHub

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

Closed
stym06 wants to merge 2 commits into from
Closed

Change DateTimeFormatSpec delimiter #8727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1635d43
add first changes
May 18, 2022
c4c9ec7
update DateTimeFormatSpec and tests
May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions pinot-common/src/test/java/org/apache/pinot/common/data/DateTimeFormatSpecTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,26 +248,26 @@ public Object[][] provideTestConstructFormatData() {

List<Object[]> entries = new ArrayList<>();

entries.add(new Object[]{1, TimeUnit.HOURS, "EPOCH", null, new DateTimeFormatSpec("1:HOURS:EPOCH"), null});
entries.add(new Object[]{1, TimeUnit.HOURS, "EPOCH", "yyyyMMdd", new DateTimeFormatSpec("1:HOURS:EPOCH"), null});
entries.add(new Object[]{5, TimeUnit.MINUTES, "EPOCH", null, new DateTimeFormatSpec("5:MINUTES:EPOCH"), null});
entries.add(new Object[]{1, TimeUnit.HOURS, "EPOCH", null, new DateTimeFormatSpec("EPOCH|HOURS|1"), null});
entries.add(new Object[]{1, TimeUnit.HOURS, "EPOCH", "yyyyMMdd", new DateTimeFormatSpec("EPOCH|HOURS|1"), null});
entries.add(new Object[]{5, TimeUnit.MINUTES, "EPOCH", null, new DateTimeFormatSpec("EPOCH|MINUTES|5"), null});
entries.add(new Object[]{0, TimeUnit.HOURS, "EPOCH", null, null, null});
entries.add(new Object[]{1, null, "EPOCH", null, null, null});
entries.add(new Object[]{1, TimeUnit.HOURS, null, null, null, null});
entries.add(new Object[]{1, TimeUnit.HOURS, "DUMMY", "yyyyMMdd", null, null});
entries.add(new Object[]{
1, TimeUnit.HOURS, "SIMPLE_DATE_FORMAT", "yyyyMMdd", null,
new DateTimeFormatSpec("1:HOURS:SIMPLE_DATE_FORMAT:yyyyMMdd")
1, TimeUnit.DAYS, "SIMPLE_DATE_FORMAT", "yyyyMMdd tz(UTC)", null,
new DateTimeFormatSpec("SIMPLE_DATE_FORMAT|yyyyMMdd|tz(UTC)")
});
entries.add(new Object[]{
1, TimeUnit.HOURS, "SIMPLE_DATE_FORMAT", "yyyyMMdd tz(America/Los_Angeles)", null,
new DateTimeFormatSpec("1:HOURS:SIMPLE_DATE_FORMAT:yyyyMMdd tz(America/Los_Angeles)")
1, TimeUnit.DAYS, "SIMPLE_DATE_FORMAT", "yyyyMMdd tz(America/Los_Angeles)", null,
new DateTimeFormatSpec("SIMPLE_DATE_FORMAT|yyyyMMdd|tz(America/Los_Angeles)")
});
entries.add(new Object[]{1, TimeUnit.HOURS, "SIMPLE_DATE_FORMAT", null, null, null});
entries.add(new Object[]{-1, TimeUnit.HOURS, "SIMPLE_DATE_FORMAT", "yyyyMMDD", null, null});
entries.add(new Object[]{1, TimeUnit.DAYS, "SIMPLE_DATE_FORMAT", null, null, null});
entries.add(new Object[]{-1, TimeUnit.DAYS, "SIMPLE_DATE_FORMAT", "yyyyMMDD", null, null});
entries.add(new Object[]{
1, TimeUnit.HOURS, "SIMPLE_DATE_FORMAT", "M/d/yyyy h:mm:ss a", null,
new DateTimeFormatSpec("1:HOURS:SIMPLE_DATE_FORMAT:M/d/yyyy h:mm:ss a")
1, TimeUnit.DAYS, "SIMPLE_DATE_FORMAT", "M/d/yyyy h:mm:ss a tz(UTC)", null,
new DateTimeFormatSpec("SIMPLE_DATE_FORMAT|M/d/yyyy h:mm:ss a|tz(UTC)")
});
return entries.toArray(new Object[entries.size()][]);
}
Expand Down
6 changes: 3 additions & 3 deletions pinot-spi/src/main/java/org/apache/pinot/spi/data/DateTimeFormatPatternSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
public class DateTimeFormatPatternSpec {

/** eg: yyyyMMdd tz(CST) or yyyyMMdd HH tz(GMT+0700) or yyyyMMddHH tz(America/Chicago) **/
private static final Pattern SDF_PATTERN_WITH_TIMEZONE = Pattern.compile("^(.+)( tz[ ]*\\((.+)\\))[ ]*");
private static final int SDF_PATTERN_GROUP = 1;
private static final int TIMEZONE_GROUP = 3;
public static final Pattern SDF_PATTERN_WITH_TIMEZONE = Pattern.compile("^(.+)( tz[ ]*\\((.+)\\))[ ]*");
public static final int SDF_PATTERN_GROUP = 1;
public static final int TIMEZONE_GROUP = 2;
public static final DateTimeZone DEFAULT_DATETIMEZONE = DateTimeZone.UTC;
public static final Locale DEFAULT_LOCALE = Locale.ENGLISH;

Expand Down
73 changes: 50 additions & 23 deletions pinot-spi/src/main/java/org/apache/pinot/spi/data/DateTimeFormatSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,40 @@

import com.google.common.base.Joiner;
import com.google.common.base.Preconditions;

import java.sql.Time;
import java.sql.Timestamp;
import java.util.TimeZone;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;

import org.apache.commons.lang3.StringUtils;
import org.apache.pinot.spi.data.DateTimeFieldSpec.TimeFormat;
import org.apache.pinot.spi.utils.EqualityUtils;
import org.apache.pinot.spi.utils.TimestampUtils;
import org.joda.time.DateTimeZone;
import org.joda.time.format.DateTimeFormatter;

import static org.apache.pinot.spi.data.DateTimeFormatPatternSpec.SDF_PATTERN_GROUP;
import static org.apache.pinot.spi.data.DateTimeFormatPatternSpec.TIMEZONE_GROUP;


/**
* Class to represent format from {@link DateTimeFieldSpec}
*/
public class DateTimeFormatSpec {

public static final String NUMBER_REGEX = "[1-9][0-9]*";
public static final String COLON_SEPARATOR = ":";
public static final String COLON_SEPARATOR = "|";

/* DateTimeFieldSpec format is of format size:timeUnit:timeformat:pattern tz(timezone)
* tz(timezone) is optional. If not specified, UTC timezone is used */
public static final int FORMAT_SIZE_POSITION = 0;
public static final int FORMAT_SIZE_POSITION = 2;
public static final int FORMAT_UNIT_POSITION = 1;
public static final int FORMAT_TIMEFORMAT_POSITION = 2;
public static final int FORMAT_PATTERN_POSITION = 3;
public static final int MIN_FORMAT_TOKENS = 3;
public static final int MAX_FORMAT_TOKENS = 4;
public static final int FORMAT_TIMEFORMAT_POSITION = 0;
public static final int FORMAT_PATTERN_POSITION = 2;
public static final int MIN_FORMAT_TOKENS = 1;
public static final int MAX_FORMAT_TOKENS = 3;

private final String _format;
private final int _size;
Expand All @@ -58,15 +66,19 @@ public DateTimeFormatSpec(String format) {
String[] formatTokens = StringUtils.split(format, COLON_SEPARATOR, MAX_FORMAT_TOKENS);
if (formatTokens.length == MAX_FORMAT_TOKENS) {
_patternSpec = new DateTimeFormatPatternSpec(formatTokens[FORMAT_TIMEFORMAT_POSITION],
formatTokens[FORMAT_PATTERN_POSITION]);
String.format("%s tz(%s)",formatTokens[FORMAT_UNIT_POSITION], formatTokens[FORMAT_PATTERN_POSITION]));
} else {
_patternSpec = new DateTimeFormatPatternSpec(formatTokens[FORMAT_TIMEFORMAT_POSITION]);
}
if (_patternSpec.getTimeFormat() == TimeFormat.TIMESTAMP) {
// TIMESTAMP type stores millis since epoch
_size = 1;
_unitSpec = new DateTimeFormatUnitSpec("MILLISECONDS");
} else {
} else if (_patternSpec.getTimeFormat() == TimeFormat.SIMPLE_DATE_FORMAT) {
_size = 1;
_unitSpec = new DateTimeFormatUnitSpec("DAYS");
}
else {
_size = Integer.parseInt(formatTokens[FORMAT_SIZE_POSITION]);
_unitSpec = new DateTimeFormatUnitSpec(formatTokens[FORMAT_UNIT_POSITION]);
}
Expand All @@ -76,7 +88,11 @@ public DateTimeFormatSpec(String format) {
* Constructs a dateTimeSpec format, given the components of a format
*/
public DateTimeFormatSpec(int columnSize, String columnUnit, String columnTimeFormat) {
_format = Joiner.on(COLON_SEPARATOR).join(columnSize, columnUnit, columnTimeFormat);
if(columnTimeFormat.equals(TimeFormat.TIMESTAMP.toString())) {
_format = "TIMESTAMP";
} else {
_format = Joiner.on(COLON_SEPARATOR).join(columnTimeFormat, columnUnit, columnSize);
}
validateFormat(_format);

_size = columnSize;
Expand All @@ -86,15 +102,24 @@ public DateTimeFormatSpec(int columnSize, String columnUnit, String columnTimeFo

/**
* Constructs a dateTimeSpec format, given the components of a format
* @param sdfPattern and tz
* @param sdfPatternWithTz and tz
*/
public DateTimeFormatSpec(int columnSize, String columnUnit, String columnTimeFormat, String sdfPattern) {
_format = Joiner.on(COLON_SEPARATOR).join(columnSize, columnUnit, columnTimeFormat, sdfPattern);
public DateTimeFormatSpec(int columnSize, String columnUnit, String columnTimeFormat, String sdfPatternWithTz) {
String timeFormat = null;
String timeZoneString = null;
Matcher m = DateTimeFormatPatternSpec.SDF_PATTERN_WITH_TIMEZONE.matcher(sdfPatternWithTz);
if (m.find()) {
timeFormat = m.group(SDF_PATTERN_GROUP).trim();
timeZoneString = m.group(TIMEZONE_GROUP).trim();
} else {
timeFormat = sdfPatternWithTz;
}
_format = Joiner.on(COLON_SEPARATOR).join(columnTimeFormat, timeFormat, timeZoneString);
validateFormat(_format);

_size = columnSize;
_unitSpec = new DateTimeFormatUnitSpec(columnUnit);
_patternSpec = new DateTimeFormatPatternSpec(columnTimeFormat, sdfPattern);
_patternSpec = new DateTimeFormatPatternSpec(columnTimeFormat, sdfPatternWithTz);
}

public String getFormat() {
Expand Down Expand Up @@ -181,22 +206,24 @@ public static void validateFormat(String format) {
Preconditions.checkNotNull(format, "Format string in dateTimeFieldSpec must not be null");
String[] formatTokens = StringUtils.split(format, COLON_SEPARATOR, MAX_FORMAT_TOKENS);
Preconditions.checkState(formatTokens.length >= MIN_FORMAT_TOKENS && formatTokens.length <= MAX_FORMAT_TOKENS,
"Incorrect format: %s. Must be of format 'size:timeunit:timeformat(:pattern)'", format);
Preconditions.checkState(formatTokens[FORMAT_SIZE_POSITION].matches(NUMBER_REGEX),
"Incorrect format size: %s in format: %s. Must be of format '[0-9]+:<TimeUnit>:<TimeFormat>(:pattern)'",
formatTokens[FORMAT_SIZE_POSITION], format);
"Incorrect format: %s. Must be of format 'EPOCH|<timeUnit>|<size> or SIMPLE_DATE_FORMAT|<timeFormat>|<timezone> or TIMESTAMP'", format);

DateTimeFormatUnitSpec.validateUnitSpec(formatTokens[FORMAT_UNIT_POSITION]);
if(formatTokens[0].equals(TimeFormat.EPOCH.toString())) {
Preconditions.checkState(formatTokens[FORMAT_SIZE_POSITION].matches(NUMBER_REGEX),
"Incorrect format size: %s in format: %s. Must be of format 'EPOCH|<TimeUnit>|[0-9]+'",
formatTokens[FORMAT_SIZE_POSITION], format);
DateTimeFormatUnitSpec.validateUnitSpec(formatTokens[FORMAT_UNIT_POSITION]);
}

if (formatTokens.length == MIN_FORMAT_TOKENS) {
Preconditions.checkState(formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.EPOCH.toString())
|| formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.TIMESTAMP.toString()),
"Incorrect format type: %s in format: %s. Must be of '[0-9]+:<TimeUnit>:EPOCH|TIMESTAMP'",
Preconditions.checkState(formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.TIMESTAMP.toString()),
"Incorrect format type: %s in format: %s. Must be of 'TIMESTAMP'",
formatTokens[FORMAT_TIMEFORMAT_POSITION], format);
} else {
Preconditions
.checkState(formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.SIMPLE_DATE_FORMAT.toString()),
"Incorrect format type: %s in format: %s. Must be of '[0-9]+:<TimeUnit>:SIMPLE_DATE_FORMAT:pattern'",
.checkState(formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.SIMPLE_DATE_FORMAT.toString()) ||
formatTokens[FORMAT_TIMEFORMAT_POSITION].equals(TimeFormat.EPOCH.toString()),
"Incorrect format type: %s in format: %s. Must be of 'SIMPLE_DATE_FORMAT/EPOCH | <TimeUnit>/<TimeFormat> | ([0-9]+) / (timezone)'",
formatTokens[FORMAT_TIMEFORMAT_POSITION], format);
}
}
Expand Down