Skip to contents

Update a column

Usage

hb_update_column(
  client,
  table,
  name,
  ...,
  new_name = NULL,
  new_type = NULL,
  column_data = NULL
)

Arguments

client

A harbour_client.

table

Table name.

name

Column name.

...

These dots are for future extensions and must be empty.

new_name

Optional new column name. Sends op_type = "rename_column".

new_type

Optional new SeaTable column type. Sends op_type = "modify_column_type". SeaTable performs one operation per request, so this cannot be combined with new_name.

column_data

Optional list of column options, sent with the type change. Given without new_type, it reconfigures the column under its current type, which harbouR asks the server for - SeaTable requires the type to be named.

Value

Invisibly returns the client.

Examples

# needs a SeaTable server and an API token
if (FALSE) { # \dontrun{
client <- hb_client()
hb_update_column(client, "Samples", "Notes", new_name = "Comments")
} # }