Skip to main content

get_metadata_field_id

Function get_metadata_field_id 

Source
pub fn get_metadata_field_id(column_name: &str) -> Result<i32>
Expand description

Returns the field ID for a metadata column name.

This maps every reserved name to its field id, including the position-delete-file internal columns pos and file_path, which are not _-prefixed. It is therefore not a membership test for data-table metadata columns: get_metadata_field_id("pos") returns Ok even though pos is a valid user data column name. To decide whether a name is a projectable data-table metadata column, use is_metadata_column_name.

§Arguments

  • column_name - The metadata column name

§Returns

The field ID of the metadata column, or an error if the column name is not recognized