Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/xuanwo/add-release-docs' i…
Browse files Browse the repository at this point in the history
…nto add-release-docs
  • Loading branch information
Xuanwo committed Jan 23, 2024
2 parents ce830e2 + c1d058e commit d03612a
Show file tree
Hide file tree
Showing 21 changed files with 973 additions and 232 deletions.
2 changes: 1 addition & 1 deletion .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

github:
description: "Apache Iceberg"
homepage: https://iceberg.apache.org/
homepage: https://rust.iceberg.apache.org/
labels:
- iceberg
- apache
Expand Down
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ The fastest way is:

### Bring your own toolbox

#### Install rust

iceberg-rust is primarily a Rust project. To build iceberg-rust, you will need to set up Rust development first. We highly recommend using [rustup](https://rustup.rs/) for the setup process.

For Linux or MacOS, use the following command:
Expand All @@ -108,11 +110,20 @@ $ cargo version
cargo 1.69.0 (6e9a83356 2023-04-12)
```

#### Install docker

Currently, iceberg-rust uses docker to set up environment for integration tests.

You can learn how to install docker from [here](https://docs.docker.com/get-docker/).

For macos users, you can install [OrbStack](https://orbstack.dev/) as a docker alternative.

## Build

* To compile the project: `make build`
* To check code styles: `make check`
* To run tests: `make test`
* To run unit tests only: `make unit-test`
* To run all tests: `make test`

## Code of Conduct

Expand Down
10 changes: 10 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@
resolver = "2"
members = ["crates/catalog/*", "crates/iceberg", "crates/test_utils"]

[workspace.package]
version = "0.1.0"
edition = "2021"
homepage = "https://rust.iceberg.apache.org/"

repository = "https://github.com/apache/iceberg-rust"
license = "Apache-2.0"

[workspace.dependencies]
anyhow = "1.0.72"
apache-avro = "0.16"
Expand Down Expand Up @@ -59,3 +67,5 @@ typed-builder = "^0.18"
url = "2"
urlencoding = "2"
uuid = "1.6.1"

tera = "1"
10 changes: 9 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,15 @@ cargo-sort:
cargo install cargo-sort
cargo sort -c -w

check: check-fmt check-clippy cargo-sort
fix-toml:
cargo install taplo-cli --locked
taplo fmt

check-toml:
cargo install taplo-cli --locked
taplo check

check: check-fmt check-clippy cargo-sort check-toml

unit-test:
cargo test --no-fail-fast --lib --all-features --workspace
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ expand to other service.

| Feature | Status |
|------------------------------------------------------------|-------------|
| File based task planning | In progress |
| File based task planning | Done |
| Size based task planning | Not started |
| Filter pushdown(manifest evaluation, partition prunning) | Not started |
| Apply deletions, including equality and position deletions | Not started |
Expand Down
9 changes: 5 additions & 4 deletions crates/catalog/hms/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@

[package]
name = "iceberg-catalog-hms"
version = "0.1.0"
edition = "2021"
version = { workspace = true }
edition = { workspace = true }
homepage = { workspace = true }

categories = ["database"]
description = "Apache Iceberg Hive Metastore Catalog Support"
repository = "https://github.com/apache/iceberg-rust"
license = "Apache-2.0"
repository = { workspace = true }
license = { workspace = true }
keywords = ["iceberg", "hive", "catalog"]

[dependencies]
Expand Down
9 changes: 5 additions & 4 deletions crates/catalog/rest/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@

[package]
name = "iceberg-catalog-rest"
version = "0.1.0"
edition = "2021"
version = { workspace = true }
edition = { workspace = true }
homepage = { workspace = true }

categories = ["database"]
description = "Apache Iceberg Rust REST API"
repository = "https://github.com/apache/iceberg-rust"
license = "Apache-2.0"
repository = { workspace = true }
license = { workspace = true }
keywords = ["iceberg", "rest", "catalog"]

[dependencies]
Expand Down
10 changes: 6 additions & 4 deletions crates/iceberg/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@

[package]
name = "iceberg"
version = "0.1.0"
edition = "2021"
version = { workspace = true }
edition = { workspace = true }
homepage = { workspace = true }

categories = ["database"]
description = "Apache Iceberg Rust implementation"
repository = "https://github.com/apache/iceberg-rust"
license = "Apache-2.0"
repository = { workspace = true }
license = { workspace = true }
keywords = ["iceberg"]

[dependencies]
Expand Down Expand Up @@ -62,4 +63,5 @@ uuid = { workspace = true }
[dev-dependencies]
pretty_assertions = { workspace = true }
tempfile = { workspace = true }
tera = { workspace = true }
tokio = { workspace = true }
2 changes: 2 additions & 0 deletions crates/iceberg/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,8 @@ define_from_err!(
"Failed to convert decimal literal to rust decimal"
);

define_from_err!(std::io::Error, ErrorKind::Unexpected, "IO Operation failed");

/// Helper macro to check arguments.
///
///
Expand Down
2 changes: 2 additions & 0 deletions crates/iceberg/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ mod avro;
pub mod io;
pub mod spec;

mod scan;

#[allow(dead_code)]
pub mod expr;
pub mod transaction;
Expand Down
Loading

0 comments on commit d03612a

Please sign in to comment.