statelydb 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b94f8450c52c3516c73d06b1a031eda14b971cc357c8a8dcd5194864ecfdf89
-  data.tar.gz: 33ed8865a216af57d1ea99ffe9c24cd37a078e2ba555d3a04b654e8f25f9fdb3
+  metadata.gz: 6d5953d075d48d8ca4449644bb88fe0792587f00da52e29d0937b02416b0c0a0
+  data.tar.gz: 424e94dd43130382ec000b986d701581dd3a76a7e404ae7c4d2f0b3f3d8927b1
 SHA512:
-  metadata.gz: 1e163f64ad570dff9ace904d59137e2134a215d28da6540422943ba6b9b4ea2c23b95863aa6195e84ec06e617a3b494f487851174fe6bf6e05eb5bb09d9a3f88
-  data.tar.gz: bc39bdaa7a57f7e7610cfdbd3b0bc088086d166f122f7355cc57db01c6cfd8d119a2a470a4ff103f38aefa3f43b1493958e39be0d3f6b342fb97c1d99df0ae23
+  metadata.gz: 2f4c26cdb3399124ee45110ad92611551a64d14df7548d92a537797eef804191d538c267bfc82d9c6c20f9e2f3812fd13f9f4fcfb3b60339df743b265b05e1e9
+  data.tar.gz: 4661408175189b2ef7320a145bee131404eb0b6a542b00e846dfb8fee0a4d3fdbdfb660d43a675b7362d5b7b94d6e17c3fd0a63cda284e624e4d13419ab7b3be

data/lib/api/db/transaction_pb.rb

@@ -15,7 +15,7 @@ require 'api/db/put_pb'
 require 'google/protobuf/empty_pb'
 
 
-descriptor_data = "\n\x14\x64\x62/transaction.proto\x12\nstately.db\x1a\x16\x64\x62/continue_list.proto\x1a\x0f\x64\x62/delete.proto\x1a\x0c\x64\x62/get.proto\x1a\rdb/item.proto\x1a\x16\x64\x62/item_property.proto\x1a\rdb/list.proto\x1a\x15\x64\x62/list_filters.proto\x1a\x0c\x64\x62/put.proto\x1a\x1bgoogle/protobuf/empty.proto\"\x9f\x04\n\x12TransactionRequest\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x34\n\x05\x62\x65gin\x18\x02 \x01(\x0b\x32\x1c.stately.db.TransactionBeginH\x00R\x05\x62\x65gin\x12\x39\n\tget_items\x18\x03 \x01(\x0b\x32\x1a.stately.db.TransactionGetH\x00R\x08getItems\x12\x41\n\nbegin_list\x18\x04 \x01(\x0b\x32 .stately.db.TransactionBeginListH\x00R\tbeginList\x12J\n\rcontinue_list\x18\x05 \x01(\x0b\x32#.stately.db.TransactionContinueListH\x00R\x0c\x63ontinueList\x12\x39\n\tput_items\x18\x06 \x01(\x0b\x32\x1a.stately.db.TransactionPutH\x00R\x08putItems\x12\x42\n\x0c\x64\x65lete_items\x18\x07 \x01(\x0b\x32\x1d.stately.db.TransactionDeleteH\x00R\x0b\x64\x65leteItems\x12\x30\n\x06\x63ommit\x18\x08 \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x06\x63ommit\x12.\n\x05\x61\x62ort\x18\t \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x05\x61\x62ortB\t\n\x07\x63ommand\"\xc8\x02\n\x13TransactionResponse\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x45\n\x0bget_results\x18\x02 \x01(\x0b\x32\".stately.db.TransactionGetResponseH\x00R\ngetResults\x12\x38\n\x07put_ack\x18\x03 \x01(\x0b\x32\x1d.stately.db.TransactionPutAckH\x00R\x06putAck\x12H\n\x0clist_results\x18\x04 \x01(\x0b\x32#.stately.db.TransactionListResponseH\x00R\x0blistResults\x12=\n\x08\x66inished\x18\x05 \x01(\x0b\x32\x1f.stately.db.TransactionFinishedH\x00R\x08\x66inishedB\x08\n\x06result\"v\n\x10TransactionBegin\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12*\n\x11schema_version_id\x18\x02 \x01(\rR\x0fschemaVersionId\x12\x1b\n\tschema_id\x18\x03 \x01(\x04R\x08schemaId\"9\n\x0eTransactionGet\x12\'\n\x04gets\x18\x01 \x03(\x0b\x32\x13.stately.db.GetItemR\x04gets\"\xa3\x02\n\x14TransactionBeginList\x12&\n\x0fkey_path_prefix\x18\x01 \x01(\tR\rkeyPathPrefix\x12\x14\n\x05limit\x18\x02 \x01(\rR\x05limit\x12\x41\n\rsort_property\x18\x03 \x01(\x0e\x32\x1c.stately.db.SortablePropertyR\x0csortProperty\x12@\n\x0esort_direction\x18\x04 \x01(\x0e\x32\x19.stately.db.SortDirectionR\rsortDirection\x12H\n\x11\x66ilter_conditions\x18\t \x03(\x0b\x32\x1b.stately.db.FilterConditionR\x10\x66ilterConditions\"y\n\x17TransactionContinueList\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12?\n\tdirection\x18\x04 \x01(\x0e\x32!.stately.db.ContinueListDirectionR\tdirection\"9\n\x0eTransactionPut\x12\'\n\x04puts\x18\x01 \x03(\x0b\x32\x13.stately.db.PutItemR\x04puts\"E\n\x11TransactionDelete\x12\x30\n\x07\x64\x65letes\x18\x01 \x03(\x0b\x32\x16.stately.db.DeleteItemR\x07\x64\x65letes\"@\n\x16TransactionGetResponse\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05items\"D\n\x0bGeneratedID\x12\x14\n\x04uint\x18\x01 \x01(\x04H\x00R\x04uint\x12\x16\n\x05\x62ytes\x18\x02 \x01(\x0cH\x00R\x05\x62ytesB\x07\n\x05value\"Q\n\x11TransactionPutAck\x12<\n\rgenerated_ids\x18\x01 \x03(\x0b\x32\x17.stately.db.GeneratedIDR\x0cgeneratedIds\"\x96\x01\n\x17TransactionListResponse\x12\x37\n\x06result\x18\x01 \x01(\x0b\x32\x1d.stately.db.ListPartialResultH\x00R\x06result\x12\x36\n\x08\x66inished\x18\x02 \x01(\x0b\x32\x18.stately.db.ListFinishedH\x00R\x08\x66inishedB\n\n\x08response\"\xa7\x01\n\x13TransactionFinished\x12\x1c\n\tcommitted\x18\x01 \x01(\x08R\tcommitted\x12\x31\n\x0bput_results\x18\x02 \x03(\x0b\x32\x10.stately.db.ItemR\nputResults\x12?\n\x0e\x64\x65lete_results\x18\x03 \x03(\x0b\x32\x18.stately.db.DeleteResultR\rdeleteResultsBk\n\x0e\x63om.stately.dbB\x10TransactionProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
+descriptor_data = "\n\x14\x64\x62/transaction.proto\x12\nstately.db\x1a\x16\x64\x62/continue_list.proto\x1a\x0f\x64\x62/delete.proto\x1a\x0c\x64\x62/get.proto\x1a\rdb/item.proto\x1a\x16\x64\x62/item_property.proto\x1a\rdb/list.proto\x1a\x15\x64\x62/list_filters.proto\x1a\x0c\x64\x62/put.proto\x1a\x1bgoogle/protobuf/empty.proto\"\x9f\x04\n\x12TransactionRequest\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x34\n\x05\x62\x65gin\x18\x02 \x01(\x0b\x32\x1c.stately.db.TransactionBeginH\x00R\x05\x62\x65gin\x12\x39\n\tget_items\x18\x03 \x01(\x0b\x32\x1a.stately.db.TransactionGetH\x00R\x08getItems\x12\x41\n\nbegin_list\x18\x04 \x01(\x0b\x32 .stately.db.TransactionBeginListH\x00R\tbeginList\x12J\n\rcontinue_list\x18\x05 \x01(\x0b\x32#.stately.db.TransactionContinueListH\x00R\x0c\x63ontinueList\x12\x39\n\tput_items\x18\x06 \x01(\x0b\x32\x1a.stately.db.TransactionPutH\x00R\x08putItems\x12\x42\n\x0c\x64\x65lete_items\x18\x07 \x01(\x0b\x32\x1d.stately.db.TransactionDeleteH\x00R\x0b\x64\x65leteItems\x12\x30\n\x06\x63ommit\x18\x08 \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x06\x63ommit\x12.\n\x05\x61\x62ort\x18\t \x01(\x0b\x32\x16.google.protobuf.EmptyH\x00R\x05\x61\x62ortB\t\n\x07\x63ommand\"\xc8\x02\n\x13TransactionResponse\x12\x1d\n\nmessage_id\x18\x01 \x01(\rR\tmessageId\x12\x45\n\x0bget_results\x18\x02 \x01(\x0b\x32\".stately.db.TransactionGetResponseH\x00R\ngetResults\x12\x38\n\x07put_ack\x18\x03 \x01(\x0b\x32\x1d.stately.db.TransactionPutAckH\x00R\x06putAck\x12H\n\x0clist_results\x18\x04 \x01(\x0b\x32#.stately.db.TransactionListResponseH\x00R\x0blistResults\x12=\n\x08\x66inished\x18\x05 \x01(\x0b\x32\x1f.stately.db.TransactionFinishedH\x00R\x08\x66inishedB\x08\n\x06result\"v\n\x10TransactionBegin\x12\x19\n\x08store_id\x18\x01 \x01(\x04R\x07storeId\x12*\n\x11schema_version_id\x18\x02 \x01(\rR\x0fschemaVersionId\x12\x1b\n\tschema_id\x18\x03 \x01(\x04R\x08schemaId\"9\n\x0eTransactionGet\x12\'\n\x04gets\x18\x01 \x03(\x0b\x32\x13.stately.db.GetItemR\x04gets\"\xe4\x02\n\x14TransactionBeginList\x12&\n\x0fkey_path_prefix\x18\x01 \x01(\tR\rkeyPathPrefix\x12\x14\n\x05limit\x18\x02 \x01(\rR\x05limit\x12\x41\n\rsort_property\x18\x03 \x01(\x0e\x32\x1c.stately.db.SortablePropertyR\x0csortProperty\x12@\n\x0esort_direction\x18\x04 \x01(\x0e\x32\x19.stately.db.SortDirectionR\rsortDirection\x12H\n\x11\x66ilter_conditions\x18\t \x03(\x0b\x32\x1b.stately.db.FilterConditionR\x10\x66ilterConditions\x12?\n\x0ekey_conditions\x18\n \x03(\x0b\x32\x18.stately.db.KeyConditionR\rkeyConditions\"y\n\x17TransactionContinueList\x12\x1d\n\ntoken_data\x18\x01 \x01(\x0cR\ttokenData\x12?\n\tdirection\x18\x04 \x01(\x0e\x32!.stately.db.ContinueListDirectionR\tdirection\"9\n\x0eTransactionPut\x12\'\n\x04puts\x18\x01 \x03(\x0b\x32\x13.stately.db.PutItemR\x04puts\"E\n\x11TransactionDelete\x12\x30\n\x07\x64\x65letes\x18\x01 \x03(\x0b\x32\x16.stately.db.DeleteItemR\x07\x64\x65letes\"@\n\x16TransactionGetResponse\x12&\n\x05items\x18\x01 \x03(\x0b\x32\x10.stately.db.ItemR\x05items\"D\n\x0bGeneratedID\x12\x14\n\x04uint\x18\x01 \x01(\x04H\x00R\x04uint\x12\x16\n\x05\x62ytes\x18\x02 \x01(\x0cH\x00R\x05\x62ytesB\x07\n\x05value\"Q\n\x11TransactionPutAck\x12<\n\rgenerated_ids\x18\x01 \x03(\x0b\x32\x17.stately.db.GeneratedIDR\x0cgeneratedIds\"\x96\x01\n\x17TransactionListResponse\x12\x37\n\x06result\x18\x01 \x01(\x0b\x32\x1d.stately.db.ListPartialResultH\x00R\x06result\x12\x36\n\x08\x66inished\x18\x02 \x01(\x0b\x32\x18.stately.db.ListFinishedH\x00R\x08\x66inishedB\n\n\x08response\"\xa7\x01\n\x13TransactionFinished\x12\x1c\n\tcommitted\x18\x01 \x01(\x08R\tcommitted\x12\x31\n\x0bput_results\x18\x02 \x03(\x0b\x32\x10.stately.db.ItemR\nputResults\x12?\n\x0e\x64\x65lete_results\x18\x03 \x03(\x0b\x32\x18.stately.db.DeleteResultR\rdeleteResultsBk\n\x0e\x63om.stately.dbB\x10TransactionProtoP\x01\xa2\x02\x03SDX\xaa\x02\nStately.Db\xca\x02\nStately\\Db\xe2\x02\x16Stately\\Db\\GPBMetadata\xea\x02\x0bStately::Dbb\x06proto3"
 
 pool = ::Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)

data/lib/key_path.rb

@@ -47,7 +47,8 @@ module StatelyDB
       new.with(namespace, identifier)
     end
 
-    # If the value is a binary string, encode it as a url-safe base64 string with padding removed.
+    # If the value is a binary string, encode it as a url-safe
+    # base64 string with padding removed.
     #
     # @param value [String, StatelyDB::UUID, #to_s] The value to convert to a key id.
     # @return [String]

data/lib/statelydb.rb

@@ -127,7 +127,18 @@ module StatelyDB
     # @param prefix [String] the prefix to list
     # @param limit [Integer] the maximum number of items to return
     # @param sort_property [String] the property to sort by
-    # @param sort_direction [Symbol] the direction to sort by (:ascending or :descending)
+    # @param sort_direction [Symbol, String, Integer] the direction to sort by (:ascending or :descending)
+    # @param item_types [Array<Class, String>] the item types to filter by. The returned
+    #   items will be instances of one of these types.
+    # @param gt [StatelyDB::KeyPath | String] filters results to only include items with a key greater than the
+    #   specified value based on lexicographic ordering.
+    # @param gte [StatelyDB::KeyPath | String] filters results to only include items with a key greater than or equal to the
+    #   specified value based on lexicographic ordering.
+    # @param lt [StatelyDB::KeyPath | String] filters results to only include items with a key less than the
+    #   specified value based on lexicographic ordering.
+    # @param lte [StatelyDB::KeyPath | String] filters results to only include items with a key less than or equal to the
+    #   specified value based on lexicographic ordering.
+
     # @return [Array<StatelyDB::Item>, StatelyDB::Token] the list of Items and the token
     #
     # @example
@@ -135,15 +146,32 @@ module StatelyDB
     def begin_list(prefix,
                    limit: 100,
                    sort_property: nil,
-                   sort_direction: :ascending)
+                   sort_direction: :ascending,
+                   item_types: [],
+                   gt: nil,
+                   gte: nil,
+                   lt: nil,
+                   lte: nil)
       sort_direction = sort_direction == :ascending ? 0 : 1
-
+      key_condition_params = [
+        [Stately::Db::Operator::OPERATOR_GREATER_THAN, gt.is_a?(String) ? gt : gt&.to_s],
+        [Stately::Db::Operator::OPERATOR_GREATER_THAN_OR_EQUAL, gte.is_a?(String) ? gte : gte&.to_s],
+        [Stately::Db::Operator::OPERATOR_LESS_THAN, lt.is_a?(String) ? lt : lt&.to_s],
+        [Stately::Db::Operator::OPERATOR_LESS_THAN_OR_EQUAL, lte.is_a?(String) ? lte : lte&.to_s]
+      ]
+      key_conditions = key_condition_params
+                       .reject { |(_, value)| value.nil? }
+                       .map { |(operator, key_path)| Stately::Db::KeyCondition.new(operator: operator, key_path: key_path) }
       req = Stately::Db::BeginListRequest.new(
         store_id: @store_id,
         key_path_prefix: String(prefix),
         limit:,
         sort_property:,
         sort_direction:,
+        filter_conditions: item_types.map do |item_type|
+          Stately::Db::FilterCondition.new(item_type: item_type.respond_to?(:name) ? item_type.name.split("::").last : item_type)
+        end,
+        key_conditions: key_conditions,
         allow_stale: @allow_stale,
         schema_id: @schema::SCHEMA_ID,
         schema_version_id: @schema::SCHEMA_VERSION_ID

data/lib/transaction/transaction.rb

@@ -334,6 +334,17 @@ module StatelyDB
       # @param limit [Integer] the maximum number of items to return
       # @param sort_property [String] the property to sort by
       # @param sort_direction [Symbol] the direction to sort by (:ascending or :descending)
+      # @param item_types [Array<Class, String>] the item types to filter by. The returned
+      #   items will be instances of one of these types.
+      # @param gt [StatelyDB::KeyPath | String] filters results to only include items with a key greater than the
+      #   specified value based on lexicographic ordering.
+      # @param gte [StatelyDB::KeyPath | String] filters results to only include items with a key greater than or equal to the
+      #   specified value based on lexicographic ordering.
+      # @param lt [StatelyDB::KeyPath | String] filters results to only include items with a key less than the
+      #   specified value based on lexicographic ordering.
+      # @param lte [StatelyDB::KeyPath | String] filters results to only include items with a key less than or equal to the
+      #   specified value based on lexicographic ordering.
+
       # @return [Array(Array<StatelyDB::Item>, ::Stately::Db::ListToken)] the list of Items and the token
       #
       # Example:
@@ -344,19 +355,42 @@ module StatelyDB
       def begin_list(prefix,
                      limit: 100,
                      sort_property: nil,
-                     sort_direction: :ascending)
+                     sort_direction: :ascending,
+                     item_types: [],
+                     gt: nil,
+                     gte: nil,
+                     lt: nil,
+                     lte: nil)
         sort_direction = case sort_direction
                          when :ascending
                            0
                          else
                            1
                          end
+        key_condition_params = [
+          [Stately::Db::Operator::OPERATOR_GREATER_THAN, gt.is_a?(String) ? gt : gt&.to_s],
+          [Stately::Db::Operator::OPERATOR_GREATER_THAN_OR_EQUAL, gte.is_a?(String) ? gte : gte&.to_s],
+          [Stately::Db::Operator::OPERATOR_LESS_THAN, lt.is_a?(String) ? lt : lt&.to_s],
+          [Stately::Db::Operator::OPERATOR_LESS_THAN_OR_EQUAL, lte.is_a?(String) ? lte : lte&.to_s]
+        ]
+        key_conditions = key_condition_params
+                         .reject { |(_, value)| value.nil? }
+                         .map do |(operator, key_path)|
+          Stately::Db::KeyCondition.new(operator: operator,
+                                        key_path: key_path)
+        end
         req = Stately::Db::TransactionRequest.new(
           begin_list: Stately::Db::TransactionBeginList.new(
             key_path_prefix: String(prefix),
             limit:,
             sort_property:,
-            sort_direction:
+            sort_direction:,
+            filter_conditions: item_types.map do |item_type|
+              Stately::Db::FilterCondition.new(
+                item_type: item_type.respond_to?(:name) ? item_type.name.split("::").last : item_type
+              )
+            end,
+            key_conditions: key_conditions
           )
         )
         do_list_request_response(req)

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatelyDB
-  VERSION = "0.28.0"
+  VERSION = "0.29.0"
 end

data/rbi/db/transaction_pb.rbi

@@ -619,7 +619,8 @@ class Stately::Db::TransactionBeginList
       limit: T.nilable(Integer),
       sort_property: T.nilable(T.any(Symbol, String, Integer)),
       sort_direction: T.nilable(T.any(Symbol, String, Integer)),
-      filter_conditions: T.nilable(T::Array[T.nilable(Stately::Db::FilterCondition)])
+      filter_conditions: T.nilable(T::Array[T.nilable(Stately::Db::FilterCondition)]),
+      key_conditions: T.nilable(T::Array[T.nilable(Stately::Db::KeyCondition)])
     ).void
   end
   def initialize(
@@ -627,7 +628,8 @@ class Stately::Db::TransactionBeginList
     limit: 0,
     sort_property: :SORTABLE_PROPERTY_KEY_PATH,
     sort_direction: :SORT_ASCENDING,
-    filter_conditions: []
+    filter_conditions: [],
+    key_conditions: []
   )
   end
 
@@ -730,6 +732,102 @@ class Stately::Db::TransactionBeginList
   def clear_filter_conditions
   end
 
+  # key_conditions are a set of conditions to apply to the list operation.
+# Wherever possible, Stately will apply these key conditions at the DB layer
+# to optimize the list operation cost.
+#
+# A maximum of two key conditions are allowed, one with a GREATER_THAN (or equal to)
+# operator and one with a LESS_THAN (or equal to) operator. Together these amount to
+# a "between" condition on the key path.
+#
+# If these conditions are provided they must share the same prefix as the
+# key_path_prefix. For example this is valid:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/namespace-44"
+#       operator: GREATER_THAN_OR_EQUAL
+#     - key_path: "/group-:groupID/namespace-100"
+#       operator: LESS_THAN_OR_EQUAL
+#
+# A key_path_prefix of "/group-:groupID" would also be valid above, as the prefix is shared
+# with the key conditions.
+#
+# The following is NOT valid because the key_path_prefix does not
+# share the same prefix as the key conditions:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/beatles-1984"
+#       operator: GREATER_THAN_OR_EQUAL
+  sig { returns(T::Array[T.nilable(Stately::Db::KeyCondition)]) }
+  def key_conditions
+  end
+
+  # key_conditions are a set of conditions to apply to the list operation.
+# Wherever possible, Stately will apply these key conditions at the DB layer
+# to optimize the list operation cost.
+#
+# A maximum of two key conditions are allowed, one with a GREATER_THAN (or equal to)
+# operator and one with a LESS_THAN (or equal to) operator. Together these amount to
+# a "between" condition on the key path.
+#
+# If these conditions are provided they must share the same prefix as the
+# key_path_prefix. For example this is valid:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/namespace-44"
+#       operator: GREATER_THAN_OR_EQUAL
+#     - key_path: "/group-:groupID/namespace-100"
+#       operator: LESS_THAN_OR_EQUAL
+#
+# A key_path_prefix of "/group-:groupID" would also be valid above, as the prefix is shared
+# with the key conditions.
+#
+# The following is NOT valid because the key_path_prefix does not
+# share the same prefix as the key conditions:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/beatles-1984"
+#       operator: GREATER_THAN_OR_EQUAL
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def key_conditions=(value)
+  end
+
+  # key_conditions are a set of conditions to apply to the list operation.
+# Wherever possible, Stately will apply these key conditions at the DB layer
+# to optimize the list operation cost.
+#
+# A maximum of two key conditions are allowed, one with a GREATER_THAN (or equal to)
+# operator and one with a LESS_THAN (or equal to) operator. Together these amount to
+# a "between" condition on the key path.
+#
+# If these conditions are provided they must share the same prefix as the
+# key_path_prefix. For example this is valid:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/namespace-44"
+#       operator: GREATER_THAN_OR_EQUAL
+#     - key_path: "/group-:groupID/namespace-100"
+#       operator: LESS_THAN_OR_EQUAL
+#
+# A key_path_prefix of "/group-:groupID" would also be valid above, as the prefix is shared
+# with the key conditions.
+#
+# The following is NOT valid because the key_path_prefix does not
+# share the same prefix as the key conditions:
+#
+#   key_path_prefix: "/group-:groupID/namespace"
+#   key_conditions:
+#     - key_path: "/group-:groupID/beatles-1984"
+#       operator: GREATER_THAN_OR_EQUAL
+  sig { void }
+  def clear_key_conditions
+  end
+
   sig { params(field: String).returns(T.untyped) }
   def [](field)
   end

data/rbi/statelydb.rbi

@@ -182,7 +182,8 @@ module StatelyDB
     sig { params(namespace: String, identifier: T.nilable(T.any(String, StatelyDB::UUID, T.untyped))).returns(StatelyDB::KeyPath) }
     def self.with(namespace, identifier = nil); end
 
-    # If the value is a binary string, encode it as a url-safe base64 string with padding removed.
+    # If the value is a binary string, encode it as a url-safe
+    # base64 string with padding removed.
     # 
     # _@param_ `value` — The value to convert to a key id.
     sig { params(value: T.any(String, StatelyDB::UUID, T.untyped)).returns(String) }
@@ -259,16 +260,6 @@ module StatelyDB
     sig { params(key_paths: T.any(String, T::Array[String])).returns(T.any(T::Array[StatelyDB::Item], NilClass)) }
     def get_batch(*key_paths); end
 
-    # Begin listing Items from a StatelyDB Store at the given prefix.
-    # 
-    # _@param_ `prefix` — the prefix to list
-    # 
-    # _@param_ `limit` — the maximum number of items to return
-    # 
-    # _@param_ `sort_property` — the property to sort by
-    # 
-    # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-    # 
     # _@return_ — the list of Items and the token
     # 
     # ```ruby
@@ -276,13 +267,18 @@ module StatelyDB
     # ```
     sig do
       params(
-        prefix: String,
-        limit: Integer,
-        sort_property: T.nilable(String),
-        sort_direction: Symbol
+        prefix: T.untyped,
+        limit: T.untyped,
+        sort_property: T.untyped,
+        sort_direction: T.untyped,
+        item_types: T.untyped,
+        gt: T.untyped,
+        gte: T.untyped,
+        lt: T.untyped,
+        lte: T.untyped
       ).returns(T.any(T::Array[StatelyDB::Item], StatelyDB::Token))
     end
-    def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending); end
+    def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending, item_types: [], gt: nil, gte: nil, lt: nil, lte: nil); end
 
     # Continue listing Items from a StatelyDB Store using a token.
     # 
@@ -1010,32 +1006,27 @@ module StatelyDB
       sig { params(key_paths: T.any(String, T::Array[String])).void }
       def delete(*key_paths); end
 
-      # Begin listing Items from a StatelyDB Store at the given prefix.
-      # 
       # Example:
       #   client.data.transaction do |txn|
       #     (items, token) = txn.begin_list("/ItemType-identifier")
       #     (items, token) = txn.continue_list(token)
       #   end
       # 
-      # _@param_ `prefix` — the prefix to list
-      # 
-      # _@param_ `limit` — the maximum number of items to return
-      # 
-      # _@param_ `sort_property` — the property to sort by
-      # 
-      # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-      # 
       # _@return_ — the list of Items and the token
       sig do
         params(
-          prefix: String,
-          limit: Integer,
-          sort_property: T.nilable(String),
-          sort_direction: Symbol
+          prefix: T.untyped,
+          limit: T.untyped,
+          sort_property: T.untyped,
+          sort_direction: T.untyped,
+          item_types: T.untyped,
+          gt: T.untyped,
+          gte: T.untyped,
+          lt: T.untyped,
+          lte: T.untyped
         ).returns([T::Array[StatelyDB::Item], ::Stately::Db::ListToken])
       end
-      def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending); end
+      def begin_list(prefix, limit: 100, sort_property: nil, sort_direction: :ascending, item_types: [], gt: nil, gte: nil, lt: nil, lte: nil); end
 
       # Continue listing Items from a StatelyDB Store using a token.
       # 

data/sig/statelydb.rbs

@@ -151,7 +151,8 @@ module StatelyDB
     # ```
     def self.with: (String namespace, ?(String | StatelyDB::UUID | _ToS)? identifier) -> StatelyDB::KeyPath
 
-    # If the value is a binary string, encode it as a url-safe base64 string with padding removed.
+    # If the value is a binary string, encode it as a url-safe
+    # base64 string with padding removed.
     # 
     # _@param_ `value` — The value to convert to a key id.
     def self.to_key_id: ((String | StatelyDB::UUID | _ToS) value) -> String
@@ -220,26 +221,21 @@ module StatelyDB
     # ```
     def get_batch: (*(String | ::Array[String]) key_paths) -> (::Array[StatelyDB::Item] | NilClass)
 
-    # Begin listing Items from a StatelyDB Store at the given prefix.
-    # 
-    # _@param_ `prefix` — the prefix to list
-    # 
-    # _@param_ `limit` — the maximum number of items to return
-    # 
-    # _@param_ `sort_property` — the property to sort by
-    # 
-    # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-    # 
     # _@return_ — the list of Items and the token
     # 
     # ```ruby
     # client.data.begin_list("/ItemType-identifier", limit: 10, sort_direction: :ascending)
     # ```
     def begin_list: (
-                      String prefix,
-                      ?limit: Integer,
-                      ?sort_property: String?,
-                      ?sort_direction: Symbol
+                      untyped prefix,
+                      ?limit: untyped,
+                      ?sort_property: untyped,
+                      ?sort_direction: untyped,
+                      ?item_types: untyped,
+                      ?gt: untyped,
+                      ?gte: untyped,
+                      ?lt: untyped,
+                      ?lte: untyped
                     ) -> (::Array[StatelyDB::Item] | StatelyDB::Token)
 
     # Continue listing Items from a StatelyDB Store using a token.
@@ -891,28 +887,23 @@ module StatelyDB
       # _@return_ — nil
       def delete: (*(String | ::Array[String]) key_paths) -> void
 
-      # Begin listing Items from a StatelyDB Store at the given prefix.
-      # 
       # Example:
       #   client.data.transaction do |txn|
       #     (items, token) = txn.begin_list("/ItemType-identifier")
       #     (items, token) = txn.continue_list(token)
       #   end
       # 
-      # _@param_ `prefix` — the prefix to list
-      # 
-      # _@param_ `limit` — the maximum number of items to return
-      # 
-      # _@param_ `sort_property` — the property to sort by
-      # 
-      # _@param_ `sort_direction` — the direction to sort by (:ascending or :descending)
-      # 
       # _@return_ — the list of Items and the token
       def begin_list: (
-                        String prefix,
-                        ?limit: Integer,
-                        ?sort_property: String?,
-                        ?sort_direction: Symbol
+                        untyped prefix,
+                        ?limit: untyped,
+                        ?sort_property: untyped,
+                        ?sort_direction: untyped,
+                        ?item_types: untyped,
+                        ?gt: untyped,
+                        ?gte: untyped,
+                        ?lt: untyped,
+                        ?lte: untyped
                       ) -> [::Array[StatelyDB::Item], ::Stately::Db::ListToken]
 
       # Continue listing Items from a StatelyDB Store using a token.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A library for interacting with StatelyDB