Skip to content

Commit

Permalink
fix: rename shift() to timeShift() function (#236)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bednar
bednar authored Jun 23, 2021
1 parent e2adb62 commit 9b5a4bc
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 56 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ The `micrometer` v1.7.0 brings [support](https://github.com/micrometer-metrics/m
That is a reason why the [influxdb-spring](./spring) no longer needs provide a custom Micrometer metrics exporter.
Now you are able to use `micrometer-registry-influx`, for more info [see our docs](./spring/README.md#actuator-for-influxdb2-micrometer-registry).

#### FluxDSL
The `shift()` function renamed to `timeShift()`.

### Features
1. [#231](https://github.com/influxdata/influxdb-client-java/pull/231): Add support for Spring Boot 2.4 [spring]
2. [#229](https://github.com/influxdata/influxdb-client-java/pull/229): Support translating column name from some_col to someCol [query]

### Bug Fixes
1. [#227](https://github.com/influxdata/influxdb-client-java/pull/227): Connection URL with custom base path
1. [#236](https://github.com/influxdata/influxdb-client-java/pull/236): Rename `shift()` to `timeShift()` [FluxDSL]

### Dependencies
1. [#227](https://github.com/influxdata/influxdb-client-csharp/pull/227): Update dependencies:
Expand Down
0 .codecov.yml → codecov.yml
View file
File renamed without changes.
8 changes: 4 additions & 4 deletions flux-dsl/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -592,19 +592,19 @@ Flux flux = Flux
.set("location", "Carolina");
```

### shift
### timeShift
Shift add a fixed duration to time columns [[doc](http://bit.ly/flux-spec#shift)].
- `shift` - The amount to add to each time value. [duration]
- `duration` - The amount to add to each time value. [duration]
- `columns` - The list of all columns that should be shifted. Defaults `["_start", "_stop", "_time"]`. [array of strings]
```java
Flux flux = Flux
.from("telegraf")
.shift(10L, ChronoUnit.HOURS);
.timeShift(10L, ChronoUnit.HOURS);
```
```java
Flux flux = Flux
.from("telegraf")
.shift(10L, ChronoUnit.HOURS, new String[]{"_time", "custom"});
.timeShift(10L, ChronoUnit.HOURS, new String[]{"_time", "custom"});
```

### skew
Expand Down
50 changes: 25 additions & 25 deletions flux-dsl/src/main/java/com/influxdb/query/dsl/Flux.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@
import com.influxdb.query.dsl.functions.RenameFlux;
import com.influxdb.query.dsl.functions.SampleFlux;
import com.influxdb.query.dsl.functions.SetFlux;
import com.influxdb.query.dsl.functions.ShiftFlux;
import com.influxdb.query.dsl.functions.SkewFlux;
import com.influxdb.query.dsl.functions.SortFlux;
import com.influxdb.query.dsl.functions.SpreadFlux;
import com.influxdb.query.dsl.functions.StddevFlux;
import com.influxdb.query.dsl.functions.SumFlux;
import com.influxdb.query.dsl.functions.TailFlux;
import com.influxdb.query.dsl.functions.TimeShiftFlux;
import com.influxdb.query.dsl.functions.ToBoolFlux;
import com.influxdb.query.dsl.functions.ToDurationFlux;
import com.influxdb.query.dsl.functions.ToFloatFlux;
Expand Down Expand Up @@ -116,7 +116,7 @@
* <li>{@link RenameFlux}</li>
* <li>{@link SampleFlux}</li>
* <li>{@link SetFlux}</li>
* <li>{@link ShiftFlux}</li>
* <li>{@link TimeShiftFlux}</li>
* <li>{@link SkewFlux}</li>
* <li>{@link SortFlux}</li>
* <li>{@link SpreadFlux}</li>
Expand Down Expand Up @@ -1506,33 +1506,33 @@ public final SetFlux set(@Nonnull final String key, @Nonnull final String value)
*
* <h3>The parameters had to be defined by:</h3>
* <ul>
* <li>{@link ShiftFlux#withShift(Long, ChronoUnit)}</li>
* <li>{@link ShiftFlux#withColumns(String[])}</li>
* <li>{@link ShiftFlux#withColumns(Collection)} )}</li>
* <li>{@link ShiftFlux#withPropertyNamed(String)}</li>
* <li>{@link ShiftFlux#withPropertyNamed(String, String)}</li>
* <li>{@link ShiftFlux#withPropertyValueEscaped(String, String)}</li>
* <li>{@link TimeShiftFlux#withDuration(Long, ChronoUnit)}</li>
* <li>{@link TimeShiftFlux#withColumns(String[])}</li>
* <li>{@link TimeShiftFlux#withColumns(Collection)} )}</li>
* <li>{@link TimeShiftFlux#withPropertyNamed(String)}</li>
* <li>{@link TimeShiftFlux#withPropertyNamed(String, String)}</li>
* <li>{@link TimeShiftFlux#withPropertyValueEscaped(String, String)}</li>
* </ul>
*
* @return {@link ShiftFlux}
* @return {@link TimeShiftFlux}
*/
@Nonnull
public final ShiftFlux shift() {
return new ShiftFlux(this);
public final TimeShiftFlux timeShift() {
return new TimeShiftFlux(this);
}

/**
* Shift add a fixed duration to time columns.
*
* @param amount The amount to add to each time value
* @param unit a {@code ChronoUnit} determining how to interpret the {@code amount} parameter
* @return {@link ShiftFlux}
* @return {@link TimeShiftFlux}
*/
@Nonnull
public final ShiftFlux shift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit) {
public final TimeShiftFlux timeShift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit) {

return new ShiftFlux(this).withShift(amount, unit);
return new TimeShiftFlux(this).withDuration(amount, unit);
}

/**
Expand All @@ -1541,14 +1541,14 @@ public final ShiftFlux shift(@Nonnull final Long amount,
* @param amount The amount to add to each time value
* @param unit a {@code ChronoUnit} determining how to interpret the {@code amount} parameter
* @param columns The list of all columns that should be shifted.
* @return {@link ShiftFlux}
* @return {@link TimeShiftFlux}
*/
@Nonnull
public final ShiftFlux shift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit,
@Nonnull final String[] columns) {
public final TimeShiftFlux timeShift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit,
@Nonnull final String[] columns) {

return new ShiftFlux(this).withShift(amount, unit).withColumns(columns);
return new TimeShiftFlux(this).withDuration(amount, unit).withColumns(columns);
}

/**
Expand All @@ -1557,14 +1557,14 @@ public final ShiftFlux shift(@Nonnull final Long amount,
* @param amount The amount to add to each time value
* @param unit a {@code ChronoUnit} determining how to interpret the {@code amount} parameter
* @param columns The list of all columns that should be shifted.
* @return {@link ShiftFlux}
* @return {@link TimeShiftFlux}
*/
@Nonnull
public final ShiftFlux shift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit,
@Nonnull final Collection<String> columns) {
public final TimeShiftFlux timeShift(@Nonnull final Long amount,
@Nonnull final ChronoUnit unit,
@Nonnull final Collection<String> columns) {

return new ShiftFlux(this).withShift(amount, unit).withColumns(columns);
return new TimeShiftFlux(this).withDuration(amount, unit).withColumns(columns);
}

/**
Expand Down
26 changes: 13 additions & 13 deletions ...fluxdb/query/dsl/functions/ShiftFlux.java → ...db/query/dsl/functions/TimeShiftFlux.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

/**
* Shift add a fixed duration to time columns.
* <a href="http://bit.ly/flux-spec#shift">See SPEC</a>.
* <a href="http://bit.ly/flux-spec#timeshift">See SPEC</a>.
*
* <h3>Options</h3>
* <ul>
* <li><b>shift</b> - The amount to add to each time value [duration]</li>
* <li><b>duration</b> - The amount to add to each time value [duration]</li>
* <li><b>columns</b> - The list of all columns that should be shifted.
* Defaults `["_start", "_stop", "_time"]` [array of strings].</li>
* </ul>
Expand All @@ -43,25 +43,25 @@
* <pre>
* Flux flux = Flux
* .from("telegraf")
* .shift(10L, ChronoUnit.HOURS);
* .timeShift(10L, ChronoUnit.HOURS);
*
* Flux flux = Flux
* .from("telegraf")
* .shift(10L, ChronoUnit.HOURS, new String[]{"_time", "custom"});
* .timeShift(10L, ChronoUnit.HOURS, new String[]{"_time", "custom"});
* </pre>
*
* @author Jakub Bednar (bednar@github) (29/06/2018 10:27)
*/
public final class ShiftFlux extends AbstractParametrizedFlux {
public final class TimeShiftFlux extends AbstractParametrizedFlux {

public ShiftFlux(@Nonnull final Flux source) {
public TimeShiftFlux(@Nonnull final Flux source) {
super(source);
}

@Nonnull
@Override
protected String operatorName() {
return "shift";
return "timeShift";
}

/**
Expand All @@ -70,11 +70,11 @@ protected String operatorName() {
* @return this
*/
@Nonnull
public ShiftFlux withShift(@Nonnull final Long amount, @Nonnull final ChronoUnit unit) {
public TimeShiftFlux withDuration(@Nonnull final Long amount, @Nonnull final ChronoUnit unit) {
Arguments.checkNotNull(amount, "Amount is required");
Arguments.checkNotNull(unit, "ChronoUnit is required");

this.withPropertyValue("shift", amount, unit);
this.withPropertyValue("duration", amount, unit);

return this;
}
Expand All @@ -84,10 +84,10 @@ public ShiftFlux withShift(@Nonnull final Long amount, @Nonnull final ChronoUnit
* @return this
*/
@Nonnull
public ShiftFlux withShift(@Nonnull final String amount) {
public TimeShiftFlux withDuration(@Nonnull final String amount) {
Arguments.checkDuration(amount, "Amount");

this.withPropertyValue("shift", amount);
this.withPropertyValue("duration", amount);

return this;
}
Expand All @@ -97,7 +97,7 @@ public ShiftFlux withShift(@Nonnull final String amount) {
* @return this
*/
@Nonnull
public ShiftFlux withColumns(@Nonnull final String[] columns) {
public TimeShiftFlux withColumns(@Nonnull final String[] columns) {

Arguments.checkNotNull(columns, "Columns are required");

Expand All @@ -111,7 +111,7 @@ public ShiftFlux withColumns(@Nonnull final String[] columns) {
* @return this
*/
@Nonnull
public ShiftFlux withColumns(@Nonnull final Collection<String> columns) {
public TimeShiftFlux withColumns(@Nonnull final Collection<String> columns) {

Arguments.checkNotNull(columns, "Columns are required");

Expand Down
26 changes: 13 additions & 13 deletions ...db/query/dsl/functions/ShiftFluxTest.java → ...uery/dsl/functions/TimeShiftFluxTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,27 @@
* @author Jakub Bednar (bednar@github) (29/06/2018 10:46)
*/
@RunWith(JUnitPlatform.class)
class ShiftFluxTest {
class TimeShiftFluxTest {

@Test
void shift() {

Flux flux = Flux
.from("telegraf")
.shift(10L, ChronoUnit.HOURS);
.timeShift(10L, ChronoUnit.HOURS);

Assertions.assertThat(flux.toString()).isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> shift(shift: 10h)");
Assertions.assertThat(flux.toString()).isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> timeShift(duration: 10h)");
}

@Test
void shiftColumnsArray() {

Flux flux = Flux
.from("telegraf")
.shift(10L, ChronoUnit.HOURS, new String[]{"time", "custom"});
.timeShift(10L, ChronoUnit.HOURS, new String[]{"time", "custom"});

Assertions.assertThat(flux.toString())
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> shift(shift: 10h, columns: [\"time\", \"custom\"])");
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> timeShift(duration: 10h, columns: [\"time\", \"custom\"])");
}

@Test
Expand All @@ -68,33 +68,33 @@ void shiftColumnsCollection() {

Flux flux = Flux
.from("telegraf")
.shift(10L, ChronoUnit.HOURS, columns);
.timeShift(10L, ChronoUnit.HOURS, columns);

Assertions.assertThat(flux.toString())
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> shift(shift: 10h, columns: [\"time\", \"_start\"])");
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> timeShift(duration: 10h, columns: [\"time\", \"_start\"])");
}

@Test
void shiftByWith() {

Flux flux = Flux
.from("telegraf")
.shift()
.withShift(20L, ChronoUnit.DAYS);
.timeShift()
.withDuration(20L, ChronoUnit.DAYS);

Assertions.assertThat(flux.toString())
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> shift(shift: 20d)");
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> timeShift(duration: 20d)");
}

@Test
void shiftByString() {

Flux flux = Flux
.from("telegraf")
.shift()
.withShift("2y");
.timeShift()
.withDuration("2y");

Assertions.assertThat(flux.toString())
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> shift(shift: 2y)");
.isEqualToIgnoringWhitespace("from(bucket:\"telegraf\") |> timeShift(duration: 2y)");
}
}
3 changes: 2 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,8 @@
<excludes>**/target/**, **/*.jar, **/.git/**, **/.*, **/*.png, **/*.iml, **/*.bolt, .idea/**,
**/*nightly*/**, **/.m2/**, LICENSE, **/*.md, **/PLACEHOLDER, **/.influxdb/**, **/generated/**,
**/openapi-generator/**, **/swagger.yml, **/*.json, **/spring.factories, **/PULL_REQUEST_TEMPLATE,
release.properties/, **/pom.xml.releaseBackup, **/pom.xml.tag, **/semantic.yml, **/test.txt, **/*.csv
release.properties/, **/pom.xml.releaseBackup, **/pom.xml.tag, **/semantic.yml, **/test.txt, **/*.csv,
codecov.yml
</excludes>
<properties>
<organizationName>${project.organization.name}</organizationName>
Expand Down

0 comments on commit 9b5a4bc

Please sign in to comment.