Skip to main content
Version: Python

PartitionedTable's metadata methods

The PartitionedTable class has a handful of methods that return metadata about the PartitionedTable.

Examples on this page rely on the following code block:

from deephaven import empty_table

source = empty_table(5).update(["IntCol = i", "StrCol = `value`"])
partitioned_table = source.partition_by(["IntCol"])

constituent_changes_permitted​

The constituent_changes_permitted method returns a boolean indicating whether the constituent tables can be changed.

PartitionedTable.constituent_changes_permitted -> bool

Here is an example:

print(partitioned_table.constituent_changes_permitted)

constituent_column​

The constituent_column method returns the name of the column containing the constituent tables - __CONSTITUENT__.

PartitionedTable.constituent_column -> str

Here is an example:

print(partitioned_table.constituent_column)

constituent_tables​

The constituent_tables method returns a PartitionedTable's constituent tables as a list of strings.

PartitionedTable.constituent_tables -> List[str]

Here is an example:

print(partitioned_table.constituent_tables)

constituent_table_columns​

The constituent_table_columns method returns the column definitions of the constituent tables.

note

All constituent tables in a PartitionedTable have the same column definitions.

PartitionedTable.constituent_table_columns -> List[Column]

Here is an example:

print(partitioned_table.constituent_table_columns)

is_refreshing​

The is_refreshing method returns whether the PartitionedTable is refreshing.

PartitionedTable.is_refreshing -> bool

Here is an example:

print(partitioned_table.is_refreshing)

key_columns​

The key_columns method returns the PartitionedTable's key column names.

PartitionedTable.key_columns -> List[str]

Here is an example:

print(partitioned_table.key_columns)

unique_keys​

The unique_keys method returns whether the PartitionedTable's keys are guaranteed to be unique.

PartitionedTable.unique_keys -> bool

Here is an example:

print(partitioned_table.unique_keys)

update_graph​

The update_graph method returns the PartitionedTable's update graph.

PartitionedTable.update_graph -> UpdateGraph

Here is an example:

print(partitioned_table.update_graph)