Skip to content

docs: mark unreleased storage backends and mosaic feature in getting-started.md #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JRVector9 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: mark unreleased storage backends and mosaic feature in getting-started.md #462

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions docs/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,27 @@ Available storage features:
| `storage-memory` | In-memory |
| `storage-s3` | Amazon S3 |
| `storage-oss` | Alibaba Cloud OSS|
| `storage-cos` | Tencent Cloud COS|
| `storage-azdls` | Azure Data Lake Storage Gen2 |
| `storage-obs` | Huawei Cloud OBS |
| `storage-gcs` | Google Cloud Storage |
| `storage-cos` | Tencent Cloud COS <sup>[1]</sup> |
| `storage-azdls` | Azure Data Lake Storage Gen2 <sup>[1]</sup> |
| `storage-obs` | Huawei Cloud OBS <sup>[1]</sup> |
| `storage-gcs` | Google Cloud Storage <sup>[1]</sup> |
| `storage-hdfs` | HDFS |
| `storage-all` | All of the above |

<sup>[1]</sup> Not in the latest release yet; available on the `main` branch. To use it now, depend on the git repository instead of a published version:

```toml
[dependencies]
paimon = { git = "https://github.com/apache/paimon-rust", features = ["storage-cos"] }
```

## Optional File Formats

Mosaic data files can be read by enabling the `mosaic` feature:
Mosaic data files can be read by enabling the `mosaic` feature. This feature is not in the latest release yet; it is available on the `main` branch:

```toml
[dependencies]
paimon = { version = "0.2.0", features = ["mosaic"] }
paimon = { git = "https://github.com/apache/paimon-rust", features = ["mosaic"] }
```

The current Mosaic support is read-only. Paimon Rust can read existing `.mosaic` data files in a Paimon table, but it does not write Mosaic data files yet.
Expand Down
Loading