indexlake 0.6.0

An experimental table format with extensible index support.
Documentation 
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

mod database;
mod helper;
mod record;
mod row;
mod scalar;
mod schema;

pub use database::*;
pub(crate) use helper::*;
pub use record::*;
pub use row::*;
pub use scalar::*;
pub use schema::*;

use crate::ILResult;
use crate::expr::Expr;
use arrow::array::RecordBatch;
use arrow::datatypes::{DataType, Field, FieldRef};
use arrow_schema::Schema;
use futures::Stream;
use std::fmt::Debug;
use std::pin::Pin;
use std::sync::{Arc, LazyLock};
use uuid::Uuid;

pub type RowStream<'a> = Pin<Box<dyn Stream<Item = ILResult<Row>> + Send + 'a>>;

pub static INTERNAL_ROW_ID_FIELD_NAME: &str = "_indexlake_row_id";
pub static INTERNAL_ROW_ID_FIELD_REF: LazyLock<FieldRef> = LazyLock::new(|| {
    Arc::new(Field::new(
        INTERNAL_ROW_ID_FIELD_NAME,
        DataType::FixedSizeBinary(16),
        false,
    ))
});

#[async_trait::async_trait]
pub trait Catalog: Debug + Send + Sync {
    fn database(&self) -> CatalogDatabase;

    async fn query(&self, sql: &str, schema: CatalogSchemaRef) -> ILResult<RowStream<'static>>;

    /// Begin a new transaction.
    async fn transaction(&self) -> ILResult<Box<dyn Transaction>>;

    async fn truncate(&self, table_name: &str) -> ILResult<()>;

    async fn size(&self, table_name: &str) -> ILResult<usize>;

    fn sql_identifier(&self, ident: &str) -> String;

    fn sql_binary_literal(&self, value: &[u8]) -> String;

    fn sql_uuid_literal(&self, value: &Uuid) -> String;

    fn sql_string_literal(&self, value: &str) -> String;

    fn supports_filter(&self, filter: &Expr, schema: &Schema) -> ILResult<bool>;

    fn unparse_expr(&self, expr: &Expr) -> ILResult<String>;

    fn unparse_catalog_data_type(&self, data_type: CatalogDataType) -> String;
}

// Transaction should be rolled back when dropped.
#[async_trait::async_trait]
pub trait Transaction: Debug + Send {
    /// Execute a query and return a stream of rows.
    async fn query<'a>(
        &'a mut self,
        sql: &str,
        schema: CatalogSchemaRef,
    ) -> ILResult<RowStream<'a>>;

    /// Execute a SQL statement.
    async fn execute(&mut self, sql: &str) -> ILResult<usize>;

    /// Execute a batch of SQL statements.
    async fn execute_batch(&mut self, sqls: &[String]) -> ILResult<()>;

    /// Bulk insert rows into a table.
    /// Each backend uses its optimal strategy (COPY for Postgres, prepared statements for SQLite).
    async fn insert_rows(
        &mut self,
        table_name: &str,
        field_names: &[String],
        batches: &[RecordBatch],
    ) -> ILResult<()>;

    /// Commit the transaction.
    async fn commit(&mut self) -> ILResult<()>;

    /// Rollback the transaction.
    async fn rollback(&mut self) -> ILResult<()>;
}