Skip to content

Add client feature support matrix documentation #2445

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
leekeiabstraction wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add client feature support matrix documentation #2445

Show file tree
Hide file tree
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
114 changes: 114 additions & 0 deletions website/docs/apis/feature-support-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: "Client Feature Support Matrix"
sidebar_position: 1
---

# Client Feature Support Matrix

Fluss has a rich set of features and native data types available to users. The following tables summarize the features available across various Fluss clients.

## Data Operations

These data operations are available under TableAppend, TableScan, TableUpsert and TableLookup interfaces.

| Table Type | Operations | [Java Client](/apis/java-client.md) | Rust Client | Python Client | C++ Client |
|--------------|----------------------------|-------------------------------------|-------------|---------------|------------|
| Log | Append | ✔️ | ✔️ | ✔️ | ✔️ |
| Log | Typed Append | ✔️ | | | |
| Log | Scan | ✔️ | ✔️ | ✔️ | ✔️ |
| Log | Scan with Projection | ✔️ | ✔️ | ✔️ | ✔️ |
| Log | Typed Scan | ✔️ | | | |
| Log | Batch Scan with Limit | ✔️ | | | |
| Primary Key | Upsert | ✔️ | ✔️ | | |
| Primary Key | Upsert with Partial Update | ✔️ | ✔️ | | |
| Primary Key | Typed Upsert | ✔️ | | | |
| Primary Key | Delete | ✔️ | ✔️ | | |
| Primary Key | Lookup | ✔️ | ✔️ | | |
| Primary Key | Prefix Lookup | ✔️ | | | |
| Primary Key | Typed Lookup | ✔️ | | | |
| Primary Key | Batch Scan with Limit | ✔️ | | | |
| Primary Key | Batch Scan (Snapshot) | ✔️ | | | |

:::tip
For more details, see [Table Overview](/table-design/overview.md).
:::

## Data Types

Client support for Fluss data types are as follows:

| DataType | [Java Client](/apis/java-client.md) | Rust Client | Python Client | C++ Client |
|-----------------------------------------------------------------|-------------------------------------|-------------|---------------|------------|
| BOOLEAN | ✔️ | ✔️ | ✔️ | ✔️ |
| TINYINT | ✔️ | ✔️ | ✔️ | ✔️ |
| SMALLINT | ✔️ | ✔️ | ✔️ | ✔️ |
| INT | ✔️ | ✔️ | ✔️ | ✔️ |
| BIGINT | ✔️ | ✔️ | ✔️ | ✔️ |
| FLOAT | ✔️ | ✔️ | ✔️ | ✔️ |
| DOUBLE | ✔️ | ✔️ | ✔️ | ✔️ |
| CHAR(n) | ✔️ | ✔️ | ✔️ | ✔️ |
| STRING | ✔️ | ✔️ | ✔️ | ✔️ |
| DECIMAL(p, s) | ✔️ | ✔️ | ✔️ | |
| DATE | ✔️ | ✔️ | ✔️ | ✔️ |
| TIME | ✔️ | ✔️ | ✔️ | ✔️ |
| TIME(p) | ✔️ | ✔️ | ✔️ | ✔️ |
| TIMESTAMP | ✔️ | ✔️ | ✔️ | ✔️ |
| TIMESTAMP(p) | ✔️ | ✔️ | ✔️ | ✔️ |
| TIMESTAMP_LTZ | ✔️ | ✔️ | ✔️ | ✔️ |
| TIMESTAMP_LTZ(p) | ✔️ | ✔️ | ✔️ | ✔️ |
| BINARY(n) | ✔️ | ✔️ | ✔️ | ✔️ |
| BYTES | ✔️ | ✔️ | ✔️ | ✔️ |
| ARRAY\<t\> | ✔️ | | | |
| MAP\<kt, vt\> | ✔️ | | | |
| ROW\<n0 t0, n1 t1, ...\><br/>ROW\<n0 t0 'd0', n1 t1 'd1', ...\> | ✔️ | | | |

:::tip
For more details, see [Data Types](table-design/data-types.md).
:::

## Admin Operations

Admin operations are available under FlussAdmin interface.

| Entity | Operations | [Java Client](/apis/java-client.md) | Rust Client | Python Client | C++ Client |
|-----------|------------------------|-------------------------------------|-------------|---------------|------------|
| Database | CreateDatabase | ✔️ | ✔️ | | |
| Database | DropDatabase | ✔️ | ✔️ | | |
| Database | DatabaseExists | ✔️ | ✔️ | | |
| Database | GetDatabaseInfo | ✔️ | ✔️ | | |
| Database | ListDatabases | ✔️ | ✔️ | | |
| Table | AlterTable | ✔️ | | | |
| Table | CreateTable | ✔️ | ✔️ | ✔️ | ✔️ |
| Table | DropTable | ✔️ | ✔️ | | ✔️ |
| Table | GetTableSchema | ✔️ | | | |
| Table | GetTableInfo | ✔️ | ✔️ | ✔️ | ✔️ |
| Table | ListTables | ✔️ | ✔️ | | |
| Partition | CreatePartition | ✔️ | | | |
| Partition | DropPartition | ✔️ | | | |
| Partition | ListPartitionInfos | ✔️ | | | |
| Snapshot | GetKvSnapshotMetadata | ✔️ | | | |
| Snapshot | GetLatestKvSnapshots | ✔️ | | | |
| Snapshot | GetLatestLakeSnapshot | ✔️ | ✔️ | ✔️ | ✔️ |
| Bucket | ListOffsets | ✔️ | ✔️ | | ✔️ |
| Cluster | AlterClusterConfigs | ✔️ | | | |
| Cluster | DescribeClusterConfigs | ✔️ | | | |
| Cluster | CancelRebalance | ✔️ | | | |
| Cluster | Rebalance | ✔️ | | | |
| Cluster | ListRebalanceProgress | ✔️ | | | |
| Server | AddServerTag | ✔️ | | | |
| Server | RemoveServerTag | ✔️ | | | |
| ACL | CreateAcls | ✔️ | | | |
| ACL | DropAcls | ✔️ | | | |
| ACL | ListAcls | ✔️ | | | |

## Data Lake Formats

| Format | [Java Client](/apis/java-client.md) | Rust Client | Python Client | C++ Client |
|---------|-------------------------------------|-------------|---------------|------------|
| Iceberg | ✔️ | | | |
| Lance | ✔️ | ✔️ | | |
| Paimon | ✔️ | | | |

:::tip
For more details, see [Streaming Lakehouse](/streaming-lakehouse/overview.md).
:::
2 changes: 1 addition & 1 deletion website/docs/apis/java-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Java Client"
sidebar_position: 1
sidebar_position: 2
---

# Fluss Java Client
Expand Down