statelydb 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f957b412a2688a75b3d3070507b66463d36417426dc0eb64f9f733ed62b6b53
-  data.tar.gz: b1189624fad81d612ef0b051a449db5dfee23c4a8579450f5382905ce4190edd
+  metadata.gz: 95aa86dd76ff3446c1a86be94ad0120fdee1d17f2d0c08b02e39f4f7cf7e698f
+  data.tar.gz: bb472f0d905e06df38d40224e06ebf2bf4cb7a202487e9059875c1b76159720e
 SHA512:
-  metadata.gz: 879a11bc96fcc184d64aec696b213a7b46adc17e8bb9f7574f1fa3a15f5b5c3b5e1473b6a16c48ab1681e76d9a086c1ab3d2a388c48d35ac6ccda51d5e171ab5
-  data.tar.gz: aba8009df9c35aadd45f4bc7cf5668eb864e9c9f88cd444cb79ce4ed8dc44203125f28e7ad36118736fa5d8197520f0c981f8e3f940cad9dd6f929ea38af1fef
+  metadata.gz: e044d82595f1a7f3cdde633a3609e7a23b0f6ef1a8ee37a8fc1841a8717ba69f2521a11bb5798b8555748076fb72061cd5bc4658da8e8a63287a8355d054763f
+  data.tar.gz: 859fed28ef654e4fb96a120320e536421b41c822bbbf6095f3c2ab89b8741f998fba8d0c0284c0ae902e56b09112d19f3d71c3450c14d0f50241d0268c334246

data/lib/statelydb.rb

@@ -173,7 +173,10 @@ module StatelyDB
     # WARNING: THIS API CAN BE EXTREMELY EXPENSIVE FOR STORES WITH A LARGE NUMBER
     # OF ITEMS.
     #
-    # @param limit [Integer] the maximum number of items to return
+    # @param limit [Integer] the max number of items to retrieve. If set to 0
+    #   then the first page of results will be returned which may empty because it
+    #   does not contain items of your selected item types. Be sure to check
+    #   token.can_continue to see if there are more results to fetch.
     # @param item_types [Array<Class, String>] the item types to filter by. The returned
     #   items will be instances of one of these types.
     # @param total_segments [Integer] the total number of segments to divide the
@@ -184,7 +187,7 @@ module StatelyDB
     #
     # @example
     #   client.data.begin_scan(limit: 10, item_types: [MyItem])
-    def begin_scan(limit: 100,
+    def begin_scan(limit: 0,
                    item_types: [],
                    total_segments: nil,
                    segment_index: nil)

data/rbi/statelydb.rbi

@@ -305,7 +305,7 @@ module StatelyDB
     # WARNING: THIS API CAN BE EXTREMELY EXPENSIVE FOR STORES WITH A LARGE NUMBER
     # OF ITEMS.
     # 
-    # _@param_ `limit` — the maximum number of items to return
+    # _@param_ `limit` — the max number of items to retrieve. If set to 0 then the first page of results will be returned which may empty because it does not contain items of your selected item types. Be sure to check token.can_continue to see if there are more results to fetch.
     # 
     # _@param_ `item_types` — the item types to filter by. The returned items will be instances of one of these types.
     # 
@@ -326,7 +326,7 @@ module StatelyDB
         segment_index: T.nilable(Integer)
       ).returns(T.any(T::Array[StatelyDB::Item], StatelyDB::Token))
     end
-    def begin_scan(limit: 100, item_types: [], total_segments: nil, segment_index: nil); end
+    def begin_scan(limit: 0, item_types: [], total_segments: nil, segment_index: nil); end
 
     # continue_scan takes the token from a begin_scan call and returns more results
     # based on the original request parameters and pagination options.

data/sig/statelydb.rbs

@@ -260,7 +260,7 @@ module StatelyDB
     # WARNING: THIS API CAN BE EXTREMELY EXPENSIVE FOR STORES WITH A LARGE NUMBER
     # OF ITEMS.
     # 
-    # _@param_ `limit` — the maximum number of items to return
+    # _@param_ `limit` — the max number of items to retrieve. If set to 0 then the first page of results will be returned which may empty because it does not contain items of your selected item types. Be sure to check token.can_continue to see if there are more results to fetch.
     # 
     # _@param_ `item_types` — the item types to filter by. The returned items will be instances of one of these types.
     # 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async