Skip to content

Commit 4db5830

Browse files
committed
[docs] Add docs for alter table properties
1 parent 8dfd695 commit 4db5830

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

website/docs/apis/java-client.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,17 @@ TableInfo tableInfo = admin.getTableInfo(tablePath).get(); // blocking call
144144
System.out.println(tableInfo);
145145
```
146146

147+
## Altering Tables
148+
```java
149+
// set client.connect-timeout to 240s
150+
TableChange setOption = TableChange.set("client.connect-timeout", "240s");
151+
// remove client.writer.batch-size
152+
TableChange resetOption = TableChange.reset("client.writer.batch-size");
153+
List<TableChange> tableChanges = Arrays.asList(setOption, resetOption);
154+
// alter table
155+
admin.alterTable(tablePath, tableChanges, false).get();
156+
```
157+
147158
## Table API
148159
### Writers
149160
In order to write data to Fluss tables, first you need to create a Table instance.

website/docs/engine-flink/ddl.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,23 @@ CREATE TABLE my_table LIKE datagen (EXCLUDING OPTIONS);
209209

210210
For more details, refer to the [Flink CREATE TABLE](https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/create/#like) documentation.
211211

212+
## Alter Table
213+
214+
### Change/Add Table Properties
215+
216+
The following SQL sets `client.connect-timeout` table property to `240s`.
217+
218+
```sql title="Flink SQL"
219+
ALTER TABLE my_table SET ('client.connect-timeout' = '240s');
220+
```
221+
222+
### Reset Table Properties
223+
224+
The following SQL removes `client.connect-timeout` table property.
225+
226+
```sql title="Flink SQL"
227+
ALTER TABLE my_table RESET ('client.connect-timeout');
228+
```
212229

213230
## Drop Table
214231

website/docs/maintenance/tiered-storage/lakehouse-storage.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,11 @@ To enable lakehouse storage for a table, the table must be created with the opti
102102
Another option `table.datalake.freshness`, allows per-table configuration of data freshness in the datalake.
103103
It defines the maximum amount of time that the datalake table's content should lag behind updates to the Fluss table.
104104
Based on this target freshness, the Fluss tiering service automatically moves data from the Fluss table and updates to the datalake table, so that the data in the datalake table is kept up to date within this target.
105-
The default is `3min`, if the data does not need to be as fresh, you can specify a longer target freshness time to reduce costs.
105+
The default is `3min`, if the data does not need to be as fresh, you can specify a longer target freshness time to reduce costs.
106+
107+
## Disable Lakehouse Storage
108+
109+
### Disable Lakehouse Storage Per Table
110+
111+
To disable lakehouse storage for a table, you can set the option 'table.datalake.enabled' = 'false'.
112+
Note: Currently, once lake storage is disabled for a table, it cannot be enabled again. In the future, repeated disabling and enabling will be supported.

0 commit comments

Comments
 (0)