Skip to content

Commit 5cdb363

Browse files
authored
Add docs (#33)
* docs * docs
1 parent 4cd67ac commit 5cdb363

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

mkdocs/docs/api.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -331,12 +331,25 @@ df = pa.Table.from_pylist(
331331
table.append(df)
332332
```
333333

334-
<!-- prettier-ignore-start -->
334+
You can delete some of the data from the table by calling `tbl.delete()` with a desired `delete_filter`.
335+
336+
```python
337+
tbl.delete(delete_filter="city == 'Paris'")
338+
```
335339

336-
!!! example "Under development"
337-
Writing using PyIceberg is still under development. Support for [partial overwrites](https://github.com/apache/iceberg-python/issues/268) and writing to [partitioned tables](https://github.com/apache/iceberg-python/issues/208) is planned and being worked on.
340+
In the above example, any records where the city field value equals to `Paris` will be deleted.
341+
Running `tbl.scan().to_arrow()` will now yield:
338342

339-
<!-- prettier-ignore-end -->
343+
```
344+
pyarrow.Table
345+
city: string
346+
lat: double
347+
long: double
348+
----
349+
city: [["Amsterdam","San Francisco","Drachten"],["Groningen"]]
350+
lat: [[52.371807,37.773972,53.11254],[53.21917]]
351+
long: [[4.896029,-122.431297,6.0989],[6.56667]]
352+
```
340353

341354
## Inspecting tables
342355

0 commit comments

Comments
 (0)