Skip to content

v.db.renamecolumn

Renames a column in the attribute table connected to a given vector map.

v.db.renamecolumn map=name [layer=string] column=oldcol,newcol [--verbose] [--quiet] [--qq] [--ui]

Example:

v.db.renamecolumn map=name column=oldcol,newcol

grass.script.run_command("v.db.renamecolumn", map, layer="1", column, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("v.db.renamecolumn", map="name", column="oldcol,newcol")

Parameters

map=name [required]
    Name of vector map
    Or data source for direct OGR access
layer=string
    Layer number or name
    Vector features can have category values in different layers. This number determines which layer to use. When used with direct OGR access this is the layer name.
    Default: 1
column=oldcol,newcol [required]
    Old and new name of the column (old,new)
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

map : str, required
    Name of vector map
    Or data source for direct OGR access
    Used as: input, vector, name
layer : str, optional
    Layer number or name
    Vector features can have category values in different layers. This number determines which layer to use. When used with direct OGR access this is the layer name.
    Used as: input, layer
    Default: 1
column : tuple[str, str] | list[str] | str, required
    Old and new name of the column (old,new)
    Used as: oldcol,newcol
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

v.db.renamecolumn renames a column in the attribute table connected to a given vector map. It automatically checks the connection for the specified layer.

NOTES

If the map table is connected through the DBF or SQLite drivers, the renaming is internally done by adding a new column with new name, transferring the contents of the old column to the new column and dropping the old column. This is needed as DBF or SQLite do not support "ALTER TABLE" command to rename columns. Due to this the renamed column is found as last column of the table, it's original position cannot be maintained.

The SQLite driver will exit with an error if the column rename involves only a change of case, i.e., upper-to-lowercase, or lower-to-uppercase. The SQLite protocol considers "NAME" and "name" to be identical column names. In cases like these, the user should rename the original column to an intermediary name, then rename the intermediary to the final name.

EXAMPLES

Renaming a column:

g.copy vect=roadsmajor,myroads
v.info -c myroads
v.db.renamecolumn myroads column=ROAD_NAME,roadname
v.info -c myroads

SEE ALSO

db.execute, v.db.addcolumn, v.db.addtable, v.db.connect, v.db.dropcolumn, v.db.droptable, v.db.select, v.db.update

GRASS SQL interface

AUTHOR

Markus Neteler

SOURCE CODE

Available at: v.db.renamecolumn source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f