You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/08/05 20:22:22 UTC

[GitHub] [beam] reuvenlax opened a new pull request #12474: OrderedListState API

reuvenlax opened a new pull request #12474:
URL: https://github.com/apache/beam/pull/12474


   This PR adds the API and and in-memory implementation for the timestamp-ordered list state. The API is currently marked experimental and is still subject to change.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax merged pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax merged pull request #12474:
URL: https://github.com/apache/beam/pull/12474


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670817702


   Run Dataflow ValidatesRunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670950588


   Run Python2_PVR_Flink PreCommit


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670725606


   Run Dataflow ValidatesRunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on a change in pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on a change in pull request #12474:
URL: https://github.com/apache/beam/pull/12474#discussion_r466729615



##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling
+   * iterable. This means that only timestamps strictly less than
+   * Instant.ofEpochMilli(Long.MAX_VALUE) can be used as timestamps.
+   */
+  Iterable<TimestampedValue<T>> readRange(Instant minTimestamp, Instant limitTimestamp);
+
+  /**
+   * Clear a timestamp-limited subrange of the list.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be removed from the
+   * list.
+   */
+  void clearRange(Instant minTimestamp, Instant limitTimestamp);
+
+  OrderedListState<T> readRangeLater(Instant minTimestamp, Instant limitTimestamp);

Review comment:
       done




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670725554


   run spark validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] dpmills commented on a change in pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
dpmills commented on a change in pull request #12474:
URL: https://github.com/apache/beam/pull/12474#discussion_r466595186



##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();
+
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling
+   * iterable.
+   */
+  Iterable<TimestampedValue<T>> readRange(Instant minTimestamp, Instant limitTimestamp);
+
+  /** Clear all values in the list. */
+  @Override
+  void clear();
+
+  /**
+   * Clear a timestamp-limited subrange of the list.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be removed from the
+   * list.
+   */
+  void clearRange(Instant minTimestamp, Instant limitTimestamp);
+
+  @Override
+  OrderedListState<T> readLater();

Review comment:
       Need a readRangeLater(...) too

##########
File path: runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/WindmillStateInternals.java
##########
@@ -456,6 +470,64 @@ protected WorkItemCommitRequest persistDirectly(WindmillStateCache.ForKey cache)
     }
   }
 
+  private static class WindmillOrderedList<T> extends SimpleWindmillState
+      implements OrderedListState<T> {
+
+    private final StateNamespace namespace;
+    private final StateTag<OrderedListState<T>> spec;
+    private final ByteString stateKey;
+    private final String stateFamily;
+    private final Coder<T> elemCoder;
+
+    private WindmillOrderedList(
+        StateNamespace namespace,
+        StateTag<OrderedListState<T>> spec,
+        String stateFamily,
+        Coder<T> elemCoder,
+        boolean isNewKey) {
+      this.namespace = namespace;
+      this.spec = spec;
+      this.stateKey = encodeKey(namespace, spec);
+      this.stateFamily = stateFamily;
+      this.elemCoder = elemCoder;
+    }
+
+    @Override
+    public Iterable<TimestampedValue<T>> read() {
+      return null;

Review comment:
       If you are intentionally not implementing this for streaming DataflowRunner yet, better to throw an UnsupportedOperationException instead of returning null for these methods.
   
   Also add a comment to the class saying that it's unsupported, maybe linking to a JIRA issue that tracks support

##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();
+
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling

Review comment:
       Using an exclusive upper limit means that Instant(Long.MAX_VALUE) isn't a supported timestamp.  Do we care?  Regardless, document the exact supported timestamps for this interface

##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();

Review comment:
       Don't need to include the inherited methods here.  If you do include them, include all of them, including isEmpty




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670817069


   run spark validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670231511


   run flink validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670638852


   run spark validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670817062


   run flink validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670725432


   run flink validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670638411


   Run Dataflow ValidatesRunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670817089


   run flink portable validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670272121


   retest this please


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670272212


   Run Dataflow ValidatesRunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670638539


   run flink validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670231434


   run dataflow validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670725497


   run flink portable validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670353997


   retest this please


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-669603386


   Run Portable_Python PreCommit


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670638945


   run flink portable validatesrunner


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670970739


   @kennknowles I am merging based on @dpmills LGTM. If you see any more things that should be changed, please comment and I will open a new PR to address those comments.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on a change in pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on a change in pull request #12474:
URL: https://github.com/apache/beam/pull/12474#discussion_r466666953



##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();
+
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling
+   * iterable.
+   */
+  Iterable<TimestampedValue<T>> readRange(Instant minTimestamp, Instant limitTimestamp);
+
+  /** Clear all values in the list. */
+  @Override
+  void clear();
+
+  /**
+   * Clear a timestamp-limited subrange of the list.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be removed from the
+   * list.
+   */
+  void clearRange(Instant minTimestamp, Instant limitTimestamp);
+
+  @Override
+  OrderedListState<T> readLater();

Review comment:
       Done

##########
File path: runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/WindmillStateInternals.java
##########
@@ -456,6 +470,64 @@ protected WorkItemCommitRequest persistDirectly(WindmillStateCache.ForKey cache)
     }
   }
 
+  private static class WindmillOrderedList<T> extends SimpleWindmillState
+      implements OrderedListState<T> {
+
+    private final StateNamespace namespace;
+    private final StateTag<OrderedListState<T>> spec;
+    private final ByteString stateKey;
+    private final String stateFamily;
+    private final Coder<T> elemCoder;
+
+    private WindmillOrderedList(
+        StateNamespace namespace,
+        StateTag<OrderedListState<T>> spec,
+        String stateFamily,
+        Coder<T> elemCoder,
+        boolean isNewKey) {
+      this.namespace = namespace;
+      this.spec = spec;
+      this.stateKey = encodeKey(namespace, spec);
+      this.stateFamily = stateFamily;
+      this.elemCoder = elemCoder;
+    }
+
+    @Override
+    public Iterable<TimestampedValue<T>> read() {
+      return null;

Review comment:
       done

##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();

Review comment:
       Removed

##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+
+  /** Read the entire list ordered by timestamp. */
+  @Override
+  Iterable<TimestampedValue<T>> read();
+
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling

Review comment:
       Added documentation to this effect.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] damgad commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
damgad commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670472484


   retest this please


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] dpmills commented on a change in pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
dpmills commented on a change in pull request #12474:
URL: https://github.com/apache/beam/pull/12474#discussion_r466677463



##########
File path: sdks/java/core/src/main/java/org/apache/beam/sdk/state/OrderedListState.java
##########
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.state;
+
+import org.apache.beam.sdk.annotations.Experimental;
+import org.apache.beam.sdk.annotations.Experimental.Kind;
+import org.apache.beam.sdk.values.TimestampedValue;
+import org.joda.time.Instant;
+
+/**
+ * A {@link ReadableState} cell containing a list of values sorted by timestamp. Timestamped values
+ * can be added to the list, and subranges can be read out in order. Subranges of the list can be
+ * deleted as well.
+ */
+@Experimental(Kind.STATE)
+public interface OrderedListState<T>
+    extends GroupingState<TimestampedValue<T>, Iterable<TimestampedValue<T>>> {
+  /**
+   * Read a timestamp-limited subrange of the list. The result is ordered by timestamp.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be in the resuling
+   * iterable. This means that only timestamps strictly less than
+   * Instant.ofEpochMilli(Long.MAX_VALUE) can be used as timestamps.
+   */
+  Iterable<TimestampedValue<T>> readRange(Instant minTimestamp, Instant limitTimestamp);
+
+  /**
+   * Clear a timestamp-limited subrange of the list.
+   *
+   * <p>All values with timestamps >= minTimestamp and < limitTimestamp will be removed from the
+   * list.
+   */
+  void clearRange(Instant minTimestamp, Instant limitTimestamp);
+
+  OrderedListState<T> readRangeLater(Instant minTimestamp, Instant limitTimestamp);

Review comment:
       Add a method comment




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [beam] reuvenlax commented on pull request #12474: [BEAM-10650] OrderedListState API

Posted by GitBox <gi...@apache.org>.
reuvenlax commented on pull request #12474:
URL: https://github.com/apache/beam/pull/12474#issuecomment-670085384


   R: @dpmills 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org