recommended type

substrait-io · Nov 25, 2024 · 1a35212 · 1a35212
1 parent 8dd6403
commit 1a35212
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/proto/substrait/algebra.proto b/proto/substrait/algebra.proto
@@ -273,6 +273,7 @@ message FetchRel {
     int64 offset = 3 [deprecated = true];
     // Expression evaluated into an integer specifying the number of records to
     // skip.
+    // Recommended type for offset is int64.
     Expression offset_expr = 5;
   }
   oneof count_mode {
@@ -282,6 +283,7 @@ message FetchRel {
     int64 count = 4 [deprecated = true];
     // Expression evaluated into an integer specifying the number of records to
     // return. -1 signals that all records should be returned.
+    // Recommended type for count is int64.
     Expression count_expr = 6;
   }
   substrait.extensions.AdvancedExtension advanced_extension = 10;

diff --git a/site/docs/relations/logical_relations.md b/site/docs/relations/logical_relations.md
@@ -338,11 +338,11 @@ The fetch operation eliminates records outside a desired window. Typically corre
 
 ### Fetch Properties
 
-| Property          | Description                                                                                                                                                            | Required                 |
-| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
-| Input             | A relational input, typically with a desired orderedness property.                                                                                                     | Required                 |
-| Offset Expression | An expression which evaluates to a non-negative integer. Declares the offset for retrieval of records.                                                                 | Optional, defaults to 0. |
-| Count Expression  | An expression which evaluates to a non-negative integer or -1. Declares the number of records that should be returned. -1 signals that ALL records should be returned. | Required                 |
+| Property          | Description                                                                                                                                                                                        | Required                 |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
+| Input             | A relational input, typically with a desired orderedness property.                                                                                                                                 | Required                 |
+| Offset Expression | An expression which evaluates to a non-negative integer (recommended type is `i64`). Declares the offset for retrieval of records.                                                                 | Optional, defaults to 0. |
+| Count Expression  | An expression which evaluates to a non-negative integer or -1 (recommended type is `i64`). Declares the number of records that should be returned. -1 signals that ALL records should be returned. | Required                 |
 
 === "FetchRel Message"