table
AssertCreate
Bases: ValidatableTableRequirement
The table must not already exist; used for create transactions.
Source code in pyiceberg/table/__init__.py
AssertCurrentSchemaId
Bases: ValidatableTableRequirement
The table's current schema id must match the requirement's current-schema-id
.
Source code in pyiceberg/table/__init__.py
AssertDefaultSortOrderId
Bases: ValidatableTableRequirement
The table's default sort order id must match the requirement's default-sort-order-id
.
Source code in pyiceberg/table/__init__.py
AssertDefaultSpecId
Bases: ValidatableTableRequirement
The table's default spec id must match the requirement's default-spec-id
.
Source code in pyiceberg/table/__init__.py
AssertLastAssignedFieldId
Bases: ValidatableTableRequirement
The table's last assigned column id must match the requirement's last-assigned-field-id
.
Source code in pyiceberg/table/__init__.py
AssertLastAssignedPartitionId
Bases: ValidatableTableRequirement
The table's last assigned partition id must match the requirement's last-assigned-partition-id
.
Source code in pyiceberg/table/__init__.py
AssertRefSnapshotId
Bases: ValidatableTableRequirement
The table branch or tag identified by the requirement's ref
must reference the requirement's snapshot-id
.
if snapshot-id
is null
or missing, the ref must not already exist.
Source code in pyiceberg/table/__init__.py
AssertTableUUID
Bases: ValidatableTableRequirement
The table UUID must match the requirement's uuid
.
Source code in pyiceberg/table/__init__.py
DataScan
Bases: TableScan
Source code in pyiceberg/table/__init__.py
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 |
|
plan_files()
Plans the relevant files by filtering on the PartitionSpecs.
Returns:
Type | Description |
---|---|
Iterable[FileScanTask]
|
List of FileScanTasks that contain both data and delete files. |
Source code in pyiceberg/table/__init__.py
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 |
|
Namespace
Bases: IcebergRootModel[List[str]]
Reference to one or more levels of a namespace.
Source code in pyiceberg/table/__init__.py
StaticTable
Bases: Table
Load a table directly from a metadata file (i.e., without using a catalog).
Source code in pyiceberg/table/__init__.py
Table
Source code in pyiceberg/table/__init__.py
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 |
|
properties: Dict[str, str]
property
Properties of the table.
__eq__(other)
Return the equality of two instances of the Table class.
Source code in pyiceberg/table/__init__.py
__repr__()
Return the string representation of the Table class.
Source code in pyiceberg/table/__init__.py
append(df)
Append data to the table.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
Table
|
The Arrow dataframe that will be appended to overwrite the table |
required |
Source code in pyiceberg/table/__init__.py
current_snapshot()
Get the current snapshot for this table, or None if there is no current snapshot.
Source code in pyiceberg/table/__init__.py
history()
location()
name()
name_mapping()
Return the table's field-id NameMapping.
Source code in pyiceberg/table/__init__.py
new_snapshot_id()
Generate a new snapshot-id that's not in use.
Source code in pyiceberg/table/__init__.py
overwrite(df, overwrite_filter=ALWAYS_TRUE)
Overwrite all the data in the table.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
Table
|
The Arrow dataframe that will be used to overwrite the table |
required |
overwrite_filter |
BooleanExpression
|
ALWAYS_TRUE when you overwrite all the data, or a boolean expression in case of a partial overwrite |
ALWAYS_TRUE
|
Source code in pyiceberg/table/__init__.py
refresh()
Refresh the current table metadata.
Source code in pyiceberg/table/__init__.py
refs()
schema()
schemas()
snapshot_by_id(snapshot_id)
Get the snapshot of this table with the given id, or None if there is no matching snapshot.
snapshot_by_name(name)
Return the snapshot referenced by the given name or null if no such reference exists.
Source code in pyiceberg/table/__init__.py
sort_order()
Return the sort order of this table.
sort_orders()
spec()
specs()
to_daft()
Read a Daft DataFrame lazily from this Iceberg table.
Returns:
Type | Description |
---|---|
DataFrame
|
daft.DataFrame: Unmaterialized Daft Dataframe created from the Iceberg table |
Source code in pyiceberg/table/__init__.py
TableIdentifier
TableScan
Bases: ABC
Source code in pyiceberg/table/__init__.py
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 |
|
Transaction
Source code in pyiceberg/table/__init__.py
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
|
__enter__()
__exit__(_, value, traceback)
Close and commit the transaction.
Source code in pyiceberg/table/__init__.py
add_snapshot(snapshot)
Add a new snapshot to the table.
Returns:
Type | Description |
---|---|
Transaction
|
The transaction with the add-snapshot staged. |
Source code in pyiceberg/table/__init__.py
commit_transaction()
Commit the changes to the catalog.
Returns:
Type | Description |
---|---|
Table
|
The table with the updates applied. |
Source code in pyiceberg/table/__init__.py
remove_properties(*removals)
Remove properties.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
removals |
str
|
Properties to be removed. |
()
|
Returns:
Type | Description |
---|---|
Transaction
|
The alter table builder. |
Source code in pyiceberg/table/__init__.py
set_properties(**updates)
Set properties.
When a property is already set, it will be overwritten.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
updates |
str
|
The properties set on the table. |
{}
|
Returns:
Type | Description |
---|---|
Transaction
|
The alter table builder. |
Source code in pyiceberg/table/__init__.py
set_ref_snapshot(snapshot_id, parent_snapshot_id, ref_name, type, max_age_ref_ms=None, max_snapshot_age_ms=None, min_snapshots_to_keep=None)
Update a ref to a snapshot.
Returns:
Type | Description |
---|---|
Transaction
|
The transaction with the set-snapshot-ref staged |
Source code in pyiceberg/table/__init__.py
update_location(location)
Set the new table location.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
location |
str
|
The new location of the table. |
required |
Returns:
Type | Description |
---|---|
Transaction
|
The alter table builder. |
Source code in pyiceberg/table/__init__.py
update_schema()
Create a new UpdateSchema to alter the columns of this table.
Returns:
Type | Description |
---|---|
UpdateSchema
|
A new UpdateSchema. |
upgrade_table_version(format_version)
Set the table to a certain version.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
format_version |
Literal[1, 2]
|
The newly set version. |
required |
Returns:
Type | Description |
---|---|
Transaction
|
The alter table builder. |
Source code in pyiceberg/table/__init__.py
UpdateSchema
Source code in pyiceberg/table/__init__.py
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 |
|
__enter__()
__exit__(_, value, traceback)
add_column(path, field_type, doc=None, required=False)
Add a new column to a nested struct or Add a new top-level column.
Because "." may be interpreted as a column path separator or may be used in field names, it is not allowed to add nested column by passing in a string. To add to nested structures or to add fields with names that contain "." use a tuple instead to indicate the path.
If type is a nested type, its field IDs are reassigned when added to the existing schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
Name for the new column. |
required |
field_type |
IcebergType
|
Type for the new column. |
required |
doc |
Optional[str]
|
Documentation string for the new column. |
None
|
required |
bool
|
Whether the new column is required. |
False
|
Returns:
Type | Description |
---|---|
UpdateSchema
|
This for method chaining. |
Source code in pyiceberg/table/__init__.py
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
|
case_sensitive(case_sensitive)
Determine if the case of schema needs to be considered when comparing column names.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
case_sensitive |
bool
|
When false case is not considered in column name comparisons. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
This for method chaining |
Source code in pyiceberg/table/__init__.py
commit()
Apply the pending changes and commit.
Source code in pyiceberg/table/__init__.py
delete_column(path)
Delete a column from a table.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the column. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the delete operation staged. |
Source code in pyiceberg/table/__init__.py
make_column_optional(path)
Make a column optional.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the field. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the requirement change staged. |
Source code in pyiceberg/table/__init__.py
move_after(path, after_name)
Move the field to after another field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the field. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the move operation staged. |
Source code in pyiceberg/table/__init__.py
move_before(path, before_path)
Move the field to before another field.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the field. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the move operation staged. |
Source code in pyiceberg/table/__init__.py
move_first(path)
Move the field to the first position of the parent struct.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the field. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the move operation staged. |
Source code in pyiceberg/table/__init__.py
rename_column(path_from, new_name)
Update the name of a column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path_from |
Union[str, Tuple[str, ...]]
|
The path to the column to be renamed. |
required |
new_name |
str
|
The new path of the column. |
required |
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the rename operation staged. |
Source code in pyiceberg/table/__init__.py
update_column(path, field_type=None, required=None, doc=None)
Update the type of column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Union[str, Tuple[str, ...]]
|
The path to the field. |
required |
field_type |
Optional[IcebergType]
|
The new type |
None
|
required |
Optional[bool]
|
If the field should be required |
None
|
doc |
Optional[str]
|
Documentation describing the column |
None
|
Returns:
Type | Description |
---|---|
UpdateSchema
|
The UpdateSchema with the type update staged. |
Source code in pyiceberg/table/__init__.py
ValidatableTableRequirement
Bases: IcebergBaseModel
Source code in pyiceberg/table/__init__.py
validate(base_metadata)
abstractmethod
Validate the requirement against the base metadata.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_metadata |
Optional[TableMetadata]
|
The base metadata to be validated against. |
required |
Raises:
Type | Description |
---|---|
CommitFailedException
|
When the requirement is not met. |
Source code in pyiceberg/table/__init__.py
update_table_metadata(base_metadata, updates)
Update the table metadata with the given updates in one transaction.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_metadata |
TableMetadata
|
The base metadata to be updated. |
required |
updates |
Tuple[TableUpdate, ...]
|
The updates in one transaction. |
required |
Returns:
Type | Description |
---|---|
TableMetadata
|
The metadata with the updates applied. |