rename_columns

The rename_columns method creates a new table with specified columns renamed.

Syntax

rename_columns(cols: Union[str, Sequence[str]]) -> Table

Parameters

Parameter Type Description

cols

Union[str, Sequence[str]]

Parameter	Type	Description
cols	Union[str, Sequence[str]]	Columns that will be renamed in the new table. `"X = Y"` will rename source column `Y` to `X`.

Columns that will be renamed in the new table.

"X = Y" will rename source column Y to X.

Important

If the new column name conflicts with an existing column name in the table, the existing column will be silently replaced.

Returns

A new table that renames the specified columns.

Examples

The following example renames columns A and C:

from deephaven import new_table
from deephaven.column import string_col, int_col

source = new_table(
    [
        string_col("A", ["apple", "apple", "orange", "orange", "plum", "plum"]),
        int_col("B", [1, 1, 2, 2, 3, 3]),
        string_col(
            "C", ["Macoun", "Opal", "Navel", "Cara Cara ", "Greengage", "Mirabelle"]
        ),
        int_col("D", [1, 2, 12, 3, 2, 3]),
    ]
)

result = source.rename_columns(cols=["Fruit = A", "Type = C"])

The following example renames column C to A. Because A already exists, it is silently replaced with the renamed C column:

from deephaven import new_table
from deephaven.column import string_col, int_col

source = new_table(
    [
        string_col("A", ["apple", "apple", "orange", "orange", "plum", "plum"]),
        int_col("B", [1, 1, 2, 2, 3, 3]),
        string_col(
            "C", ["Macoun", "Opal", "Navel", "Cara Cara ", "Greengage", "Mirabelle"]
        ),
        int_col("D", [1, 2, 12, 3, 2, 3]),
    ]
)

result = source.rename_columns(cols=["A = C"])

rename_columns

Syntax

Parameters

Returns

Examples

Related documentation