RussellSpitzer commented on code in PR #7147:
URL: https://github.com/apache/iceberg/pull/7147#discussion_r1143664068


##########
docs/spark-procedures.md:
##########
@@ -587,3 +587,75 @@ Get all the snapshot ancestors by a particular snapshot
 CALL spark_catalog.system.ancestors_of('db.tbl', 1)
 CALL spark_catalog.system.ancestors_of(snapshot_id => 1, table => 'db.tbl')
 ```
+
+## Change Data Capture 
+
+### `create_changelog_view`
+
+Creates a view that contains the changes from a given table. 
+
+#### Usage
+
+| Argument Name | Required? | Type | Description                               
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                      |
+|---------------|----------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `table`       | ✔️ | string | Name of the table to create changlog view      
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                 |
+| `changelog_view`        |   | string | Name of the view to create            
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                          |
+| `options`     |   | map<string, string> | A map of Spark read options to 
use. For example, `start-snapshot-id`, the snapshot id to start reading from 
exclusively. If not provided, the table’s first snapshot will be used as the 
starting point. `end-snapshot-id`, the snapshot id to stop reading at 
inclusively. Default to the current snapshot. `start-timestamp`, the timestamp 
to start reading from exclusively. If not provided, the table’s first snapshot 
will be used as the starting point.`end-timestamp`, the timestamp to stop 
reading at inclusively. If not provided, the table’s current snapshot will be 
used as the ending point. | 
+|`compute_updates`| | boolean | Whether to compute updates. Defaults to false  
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                 | 

Review Comment:
   This is a bit confusing. I think looking at this from an outside perspective 
i'm not sure what "compute_updates" would mean. Ideally all of our descriptions 
should be a more descriptive than a restatement of the name of the column.



-- 
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.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to