1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
//! Table API for Apache Iceberg
use std::sync::Arc;
use crate::arrow::ArrowReaderBuilder;
use crate::io::object_cache::ObjectCache;
use crate::io::FileIO;
use crate::scan::TableScanBuilder;
use crate::spec::{TableMetadata, TableMetadataRef};
use crate::{Error, ErrorKind, Result, TableIdent};
/// Builder to create table scan.
pub struct TableBuilder {
file_io: Option<FileIO>,
metadata_location: Option<String>,
metadata: Option<TableMetadataRef>,
identifier: Option<TableIdent>,
readonly: bool,
disable_cache: bool,
cache_size_bytes: Option<u64>,
}
impl TableBuilder {
pub(crate) fn new() -> Self {
Self {
file_io: None,
metadata_location: None,
metadata: None,
identifier: None,
readonly: false,
disable_cache: false,
cache_size_bytes: None,
}
}
/// required - sets the necessary FileIO to use for the table
pub fn file_io(mut self, file_io: FileIO) -> Self {
self.file_io = Some(file_io);
self
}
/// optional - sets the tables metadata location
pub fn metadata_location<T: Into<String>>(mut self, metadata_location: T) -> Self {
self.metadata_location = Some(metadata_location.into());
self
}
/// required - passes in the TableMetadata to use for the Table
pub fn metadata<T: Into<TableMetadataRef>>(mut self, metadata: T) -> Self {
self.metadata = Some(metadata.into());
self
}
/// required - passes in the TableIdent to use for the Table
pub fn identifier(mut self, identifier: TableIdent) -> Self {
self.identifier = Some(identifier);
self
}
/// specifies if the Table is readonly or not (default not)
pub fn readonly(mut self, readonly: bool) -> Self {
self.readonly = readonly;
self
}
/// specifies if the Table's metadata cache will be disabled,
/// so that reads of Manifests and ManifestLists will never
/// get cached.
pub fn disable_cache(mut self) -> Self {
self.disable_cache = true;
self
}
/// optionally set a non-default metadata cache size
pub fn cache_size_bytes(mut self, cache_size_bytes: u64) -> Self {
self.cache_size_bytes = Some(cache_size_bytes);
self
}
/// build the Table
pub fn build(self) -> Result<Table> {
let Self {
file_io,
metadata_location,
metadata,
identifier,
readonly,
disable_cache,
cache_size_bytes,
} = self;
let Some(file_io) = file_io else {
return Err(Error::new(
ErrorKind::DataInvalid,
"FileIO must be provided with TableBuilder.file_io()",
));
};
let Some(metadata) = metadata else {
return Err(Error::new(
ErrorKind::DataInvalid,
"TableMetadataRef must be provided with TableBuilder.metadata()",
));
};
let Some(identifier) = identifier else {
return Err(Error::new(
ErrorKind::DataInvalid,
"TableIdent must be provided with TableBuilder.identifier()",
));
};
let object_cache = if disable_cache {
Arc::new(ObjectCache::with_disabled_cache(file_io.clone()))
} else if let Some(cache_size_bytes) = cache_size_bytes {
Arc::new(ObjectCache::new_with_capacity(
file_io.clone(),
cache_size_bytes,
))
} else {
Arc::new(ObjectCache::new(file_io.clone()))
};
Ok(Table {
file_io,
metadata_location,
metadata,
identifier,
readonly,
object_cache,
})
}
}
/// Table represents a table in the catalog.
#[derive(Debug, Clone)]
pub struct Table {
file_io: FileIO,
metadata_location: Option<String>,
metadata: TableMetadataRef,
identifier: TableIdent,
readonly: bool,
object_cache: Arc<ObjectCache>,
}
impl Table {
/// Returns a TableBuilder to build a table
pub fn builder() -> TableBuilder {
TableBuilder::new()
}
/// Returns table identifier.
pub fn identifier(&self) -> &TableIdent {
&self.identifier
}
/// Returns current metadata.
pub fn metadata(&self) -> &TableMetadata {
&self.metadata
}
/// Returns current metadata ref.
pub fn metadata_ref(&self) -> TableMetadataRef {
self.metadata.clone()
}
/// Returns current metadata location.
pub fn metadata_location(&self) -> Option<&str> {
self.metadata_location.as_deref()
}
/// Returns file io used in this table.
pub fn file_io(&self) -> &FileIO {
&self.file_io
}
/// Returns this table's object cache
pub(crate) fn object_cache(&self) -> Arc<ObjectCache> {
self.object_cache.clone()
}
/// Creates a table scan.
pub fn scan(&self) -> TableScanBuilder<'_> {
TableScanBuilder::new(self)
}
/// Returns the flag indicating whether the `Table` is readonly or not
pub fn readonly(&self) -> bool {
self.readonly
}
/// Create a reader for the table.
pub fn reader_builder(&self) -> ArrowReaderBuilder {
ArrowReaderBuilder::new(self.file_io.clone())
}
}
/// `StaticTable` is a read-only table struct that can be created from a metadata file or from `TableMetaData` without a catalog.
/// It can only be used to read metadata and for table scan.
/// # Examples
///
/// ```rust, no_run
/// # use iceberg::io::FileIO;
/// # use iceberg::table::StaticTable;
/// # use iceberg::TableIdent;
/// # async fn example() {
/// let metadata_file_location = "s3://bucket_name/path/to/metadata.json";
/// let file_io = FileIO::from_path(&metadata_file_location)
/// .unwrap()
/// .build()
/// .unwrap();
/// let static_identifier = TableIdent::from_strs(["static_ns", "static_table"]).unwrap();
/// let static_table =
/// StaticTable::from_metadata_file(&metadata_file_location, static_identifier, file_io)
/// .await
/// .unwrap();
/// let snapshot_id = static_table
/// .metadata()
/// .current_snapshot()
/// .unwrap()
/// .snapshot_id();
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct StaticTable(Table);
impl StaticTable {
/// Creates a static table from a given `TableMetadata` and `FileIO`
pub async fn from_metadata(
metadata: TableMetadata,
table_ident: TableIdent,
file_io: FileIO,
) -> Result<Self> {
let table = Table::builder()
.metadata(metadata)
.identifier(table_ident)
.file_io(file_io.clone())
.readonly(true)
.build();
Ok(Self(table?))
}
/// Creates a static table directly from metadata file and `FileIO`
pub async fn from_metadata_file(
metadata_file_path: &str,
table_ident: TableIdent,
file_io: FileIO,
) -> Result<Self> {
let metadata_file = file_io.new_input(metadata_file_path)?;
let metadata_file_content = metadata_file.read().await?;
let table_metadata = serde_json::from_slice::<TableMetadata>(&metadata_file_content)?;
Self::from_metadata(table_metadata, table_ident, file_io).await
}
/// Create a TableScanBuilder for the static table.
pub fn scan(&self) -> TableScanBuilder<'_> {
self.0.scan()
}
/// Get TableMetadataRef for the static table
pub fn metadata(&self) -> TableMetadataRef {
self.0.metadata_ref()
}
/// Consumes the `StaticTable` and return it as a `Table`
/// Please use this method carefully as the Table it returns remains detached from a catalog
/// and can't be used to perform modifications on the table.
pub fn into_table(self) -> Table {
self.0
}
/// Create a reader for the table.
pub fn reader_builder(&self) -> ArrowReaderBuilder {
ArrowReaderBuilder::new(self.0.file_io.clone())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_static_table_from_file() {
let metadata_file_name = "TableMetadataV2Valid.json";
let metadata_file_path = format!(
"{}/testdata/table_metadata/{}",
env!("CARGO_MANIFEST_DIR"),
metadata_file_name
);
let file_io = FileIO::from_path(&metadata_file_path)
.unwrap()
.build()
.unwrap();
let static_identifier = TableIdent::from_strs(["static_ns", "static_table"]).unwrap();
let static_table =
StaticTable::from_metadata_file(&metadata_file_path, static_identifier, file_io)
.await
.unwrap();
let snapshot_id = static_table
.metadata()
.current_snapshot()
.unwrap()
.snapshot_id();
assert_eq!(
snapshot_id, 3055729675574597004,
"snapshot id from metadata don't match"
);
}
#[tokio::test]
async fn test_static_into_table() {
let metadata_file_name = "TableMetadataV2Valid.json";
let metadata_file_path = format!(
"{}/testdata/table_metadata/{}",
env!("CARGO_MANIFEST_DIR"),
metadata_file_name
);
let file_io = FileIO::from_path(&metadata_file_path)
.unwrap()
.build()
.unwrap();
let static_identifier = TableIdent::from_strs(["static_ns", "static_table"]).unwrap();
let static_table =
StaticTable::from_metadata_file(&metadata_file_path, static_identifier, file_io)
.await
.unwrap();
let table = static_table.into_table();
assert!(table.readonly());
assert_eq!(table.identifier.name(), "static_table");
}
#[tokio::test]
async fn test_table_readonly_flag() {
let metadata_file_name = "TableMetadataV2Valid.json";
let metadata_file_path = format!(
"{}/testdata/table_metadata/{}",
env!("CARGO_MANIFEST_DIR"),
metadata_file_name
);
let file_io = FileIO::from_path(&metadata_file_path)
.unwrap()
.build()
.unwrap();
let metadata_file = file_io.new_input(metadata_file_path).unwrap();
let metadata_file_content = metadata_file.read().await.unwrap();
let table_metadata =
serde_json::from_slice::<TableMetadata>(&metadata_file_content).unwrap();
let static_identifier = TableIdent::from_strs(["ns", "table"]).unwrap();
let table = Table::builder()
.metadata(table_metadata)
.identifier(static_identifier)
.file_io(file_io.clone())
.build()
.unwrap();
assert!(!table.readonly());
assert_eq!(table.identifier.name(), "table");
}
}