Struct iceberg_rust::spec::view_metadata::GeneralViewMetadata

pub struct GeneralViewMetadata<T>
where
    T: Clone + Default,
{
    pub view_uuid: Uuid,
    pub format_version: FormatVersion,
    pub location: String,
    pub current_version_id: i64,
    pub versions: HashMap<i64, Version>,
    pub version_log: Vec<VersionLogStruct>,
    pub schemas: HashMap<i32, Schema>,
    pub properties: ViewProperties<T>,
}

Fields for the version 1 of the view metadata.

Fields

view_uuid: Uuid

A UUID that identifies the view, generated when the view is created. Implementations must throw an exception if a view’s UUID does not match the expected UUID after refreshing metadata

format_version: FormatVersion

An integer version number for the view format; must be 1

location: String

The view’s base location. This is used to determine where to store manifest files and view metadata files.

current_version_id: i64

Current version of the view. Set to ‘1’ when the view is first created.

versions: HashMap<i64, Version>

An array of structs describing the last known versions of the view. Controlled by the table property: “version.history.num-entries”. See section Versions.

version_log: Vec<VersionLogStruct>

A list of timestamp and version ID pairs that encodes changes to the current version for the view. Each time the current-version-id is changed, a new entry should be added with the last-updated-ms and the new current-version-id.

schemas: HashMap<i32, Schema>

A list of schemas, the same as the ‘schemas’ field from Iceberg table spec.

properties: ViewProperties<T>

A string to string map of view properties. This is used for metadata such as “comment” and for settings that affect view maintenance. This is not intended to be used for arbitrary metadata.

Implementations

impl<T> GeneralViewMetadata<T>

where T: Clone + Default,

pub fn current_schema(&self, branch: Option<&str>) -> Result<&Schema, Error>

Get current schema

pub fn schema(&self, version_id: i64) -> Result<&Schema, Error>

Get schema for version

pub fn current_version( &self, snapshot_ref: Option<&str> ) -> Result<&Version, Error>

Get current version

pub fn add_schema(&mut self, schema: Schema)

Add schema to view metadata

Trait Implementations

impl<T> Clone for GeneralViewMetadata<T>

where T: Clone + Default,

fn clone(&self) -> GeneralViewMetadata<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for GeneralViewMetadata<T>

where T: Debug + Clone + Default,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Default for GeneralViewMetadata<T>

where T: Default + Clone,

fn default() -> GeneralViewMetadata<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for GeneralViewMetadata<T>

where T: Clone + Default + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<GeneralViewMetadata<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a GeneralViewMetadata<Option<()>>> for TabularMetadataRef<'a>

fn from(value: &'a GeneralViewMetadata<Option<()>>) -> TabularMetadataRef<'a>

Converts to this type from the input type.

impl<'a> From<&'a GeneralViewMetadata<String>> for TabularMetadataRef<'a>

fn from(value: &'a GeneralViewMetadata<String>) -> TabularMetadataRef<'a>

Converts to this type from the input type.

impl From<GeneralViewMetadata<Option<()>>> for TabularMetadata

fn from(value: GeneralViewMetadata<Option<()>>) -> TabularMetadata

Converts to this type from the input type.

impl From<GeneralViewMetadata<String>> for TabularMetadata

fn from(value: GeneralViewMetadata<String>) -> TabularMetadata

Converts to this type from the input type.

impl<T> PartialEq for GeneralViewMetadata<T>

where T: PartialEq + Clone + Default,

fn eq(&self, other: &GeneralViewMetadata<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for GeneralViewMetadata<T>

where T: Clone + Default + Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFrom<ViewMetadataEnum<T>> for GeneralViewMetadata<T>

where T: Clone + Default,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: ViewMetadataEnum<T> ) -> Result<GeneralViewMetadata<T>, <GeneralViewMetadata<T> as TryFrom<ViewMetadataEnum<T>>>::Error>

Performs the conversion.

impl<T> TryFrom<ViewMetadataV1<T>> for GeneralViewMetadata<T>

where T: Clone + Default,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: ViewMetadataV1<T> ) -> Result<GeneralViewMetadata<T>, <GeneralViewMetadata<T> as TryFrom<ViewMetadataV1<T>>>::Error>

Performs the conversion.

impl<T> Eq for GeneralViewMetadata<T>

where T: Eq + Clone + Default,

impl<T> StructuralPartialEq for GeneralViewMetadata<T>

where T: Clone + Default,